public final class CdaSettings extends DefaultLinkedDirtyable implements Copyable
Constructor and Description |
---|
CdaSettings() |
CdaSettings(HashStructure hash) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
copyTo(java.lang.Object object)
Copies the internal state of
this object to the specified copy . |
protected void |
copyToImpl(CdaSettings copy) |
boolean |
equals(java.lang.Object o) |
protected boolean |
equalsImpl(CdaSettings cdas)
This is a helper method for
equals(Object) that can also be used by subclasses that implement equals(Object) . |
java.net.URL[] |
getAdditionalArchives()
"Additional" archives differ from "selected" archives in that additional archives do not come from libraries in the user's project.
|
CdaFilters |
getAfterFilters() |
java.net.URL[] |
getArchivesToInclude()
Based on the selection mode and the additional archives that are set, this method will return a complete array of
URL s of the archives that should be included in their entirety during deployment. |
CdaFilters |
getBeforeFilters() |
CdaFilters |
getDuringFilters() |
HashStructure |
getHashStructure() |
SelectedArchives |
getSelectedArchives()
"Selected" archives are archives that come from the user's project libraries that are set in the current active configuration.
|
void |
setAdditionalArchives(java.net.URL[] additionalArchives)
"Additional" archives differ from "selected" archives in that additional archives do not come from libraries in the user's project.
|
void |
setAfterFilters(CdaFilters afterFilters) |
void |
setBeforeFilters(CdaFilters beforeFilters) |
void |
setDuringFilters(CdaFilters duringFilters) |
void |
setSelectedArchives(SelectedArchives selectedArchives) |
compare, compareTo, linkContainingDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyables, markDirty, setOwner, unlinkContainingDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyables
dirtyLabel, dirtyLabel, dirtyLabel, isDirty
public CdaSettings()
public CdaSettings(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(CdaSettings copy)
public CdaFilters getBeforeFilters()
public void setBeforeFilters(CdaFilters beforeFilters)
public CdaFilters getDuringFilters()
public void setDuringFilters(CdaFilters duringFilters)
public CdaFilters getAfterFilters()
public void setAfterFilters(CdaFilters afterFilters)
public SelectedArchives getSelectedArchives()
public void setSelectedArchives(SelectedArchives selectedArchives)
public java.net.URL[] getAdditionalArchives()
public void setAdditionalArchives(java.net.URL[] additionalArchives)
Each URL
in the specified array must represent a directory, even if the URL
represents a jar file. For jar files, the URL should be created using either URLFactory.newJarURL(java.io.File, String)
or URLFactory.newJarURL(URL, String)
with ""
(the empty string) as the entry name.
public java.net.URL[] getArchivesToInclude()
URL
s of the archives that should be included in their entirety during deployment.public HashStructure getHashStructure()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
protected final boolean equalsImpl(CdaSettings cdas)
equals(Object)
that can also be used by subclasses that implement equals(Object)
. It assumes that the argument is not null
.