public class CdaFilters extends DefaultLinkedDirtyable implements Copyable
Constructor and Description |
---|
CdaFilters() |
CdaFilters(HashStructure hash) |
Modifier and Type | Method and Description |
---|---|
void |
addFilter(CdaFilter filter) |
void |
addFilters(CdaFilter[] filters) |
java.lang.Object |
copyTo(java.lang.Object object)
Copies the internal state of
this object to the specified copy . |
protected void |
copyToImpl(CdaFilters copy) |
boolean |
equals(java.lang.Object o) |
protected boolean |
equalsImpl(CdaFilters cdaFilters)
This is a helper method for
equals(Object) that can also be used by subclasses that implement equals(Object) . |
CdaFilter[] |
getFilters()
Because the setter method sorts the filters, this method always returns the filters in order of their application.
|
HashStructure |
getHashStructure() |
boolean |
isIncluded(java.lang.String className)
This method determines, based on the filter settings, whether the specified class is included.
|
void |
setFilters(CdaFilter[] filters) |
compare, compareTo, linkContainingDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyables, markDirty, setOwner, unlinkContainingDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyables
dirtyLabel, dirtyLabel, dirtyLabel, isDirty
public CdaFilters()
public CdaFilters(HashStructure hash)
public java.lang.Object copyTo(java.lang.Object object)
Copyable
this
object to the specified copy
. If copy
is null
, then this method should create a new instance of this
class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.
Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this
object's state was copied.
There is a standard implementation pattern for the copyTo
method that helps avoid problems that arise when a Copyable
object is subclassed. The pattern is:
The parameter passed into thepublic Object copyTo( Object target ) { final <this_class> copy = target != null ? (<this_class>) target : new <this_class>(); copyToImpl( copy ); return copy; } protected final void copyToImpl( <this_class> copy ) { super.copyToImpl( copy ); // if necessary // put code here for copying the properties of <this_class> }
copyToImpl
method is the same type of this
class. The responsibility of copyToImpl
is to copy the state of this
class through direct access of the fields. The copyToImpl
method should not use getters and setters since these may be overridden, causing the state of this
class to be incompletely copied.copyTo
in interface Copyable
object
- The target object to which the state of this
object should be copied. If target
is null
, then the copyTo
method will return a new instance of this
class.this
object was copied. If the target
was non-null
, then the return value is the same as the target
object that was passed in; otherwise, the return value is a new instance of this
class.protected final void copyToImpl(CdaFilters copy)
public CdaFilter[] getFilters()
public void setFilters(CdaFilter[] filters)
public void addFilter(CdaFilter filter)
public void addFilters(CdaFilter[] filters)
public boolean isIncluded(java.lang.String className)
true
if the specified class is included based on the current filters. Returns false
if there is a filter which explicitly excludes the class. If no filter specifically includes or excludes, the default is to include the class, so true
is returned.java.lang.NullPointerException
- if className is null
. It is the caller's responsibility to assure that className is not null
.public HashStructure getHashStructure()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
protected final boolean equalsImpl(CdaFilters cdaFilters)
equals(Object)
that can also be used by subclasses that implement equals(Object)
. It assumes that the argument is not null
.