oracle.jdeveloper.deploy.common

Class CdaSettings

java.lang.Object

oracle.ide.model.DefaultDirtyable

oracle.jdeveloper.deploy.DefaultLinkedDirtyable

oracle.jdeveloper.deploy.common.CdaSettings

All Implemented Interfaces:

java.lang.Comparable, SubDirtyable, Dirtyable, Copyable, LinkedDirtyable

public final class CdaSettings
extends DefaultLinkedDirtyable
implements Copyable

Class dependency analyzer settings. This class represents all settings that can be used to customize the behavior of the class dependency analyzer and other supporting operations that occur related to dependency analysis and building up a manifest of output files.

Constructor Summary

Constructors

Constructor and Description
CdaSettings()
CdaSettings(HashStructure hash)

Method Summary

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 URLs 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)

Methods inherited from class oracle.jdeveloper.deploy.DefaultLinkedDirtyable

compare, compareTo, linkContainingDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyables, markDirty, setOwner, unlinkContainingDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyables

Methods inherited from class oracle.ide.model.DefaultDirtyable

dirtyLabel, dirtyLabel, dirtyLabel, isDirty

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.javatools.data.Dirtyable

isDirty

Constructor Detail

CdaSettings

public CdaSettings()

CdaSettings

public CdaSettings(HashStructure hash)

Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object object)

Description copied from interface: Copyable

Copies the internal state of 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:

    public 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>
    }
  

The parameter passed into the 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.

Specified by:

copyTo in interface Copyable

Parameters:

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.

Returns:

The object to which the state of 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.

copyToImpl

protected final void copyToImpl(CdaSettings copy)

getBeforeFilters

public CdaFilters getBeforeFilters()

setBeforeFilters

public void setBeforeFilters(CdaFilters beforeFilters)

getDuringFilters

public CdaFilters getDuringFilters()

setDuringFilters

public void setDuringFilters(CdaFilters duringFilters)

getAfterFilters

public CdaFilters getAfterFilters()

setAfterFilters

public void setAfterFilters(CdaFilters afterFilters)

getSelectedArchives

public SelectedArchives getSelectedArchives()

"Selected" archives are archives that come from the user's project libraries that are set in the current active configuration.

setSelectedArchives

public void setSelectedArchives(SelectedArchives selectedArchives)

getAdditionalArchives

public java.net.URL[] getAdditionalArchives()

"Additional" archives differ from "selected" archives in that additional archives do not come from libraries in the user's project. They are separately specified archives that are included in deployment in some way. Exactly how the additional archives are handled depends on the specific deployment profile type, but in general the entire contents of the archives are included in some form.

setAdditionalArchives

public 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. Exactly how the additional archives are handled depends on the specific deployment profile type, but in general the entire contents of the archives are included in some form.

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.

getArchivesToInclude

public java.net.URL[] getArchivesToInclude()

Based on the selection mode and the additional archives that are set, this method will return a complete array of URLs of the archives that should be included in their entirety during deployment.

getHashStructure

public HashStructure getHashStructure()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equalsImpl

protected final boolean equalsImpl(CdaSettings cdas)

This is a helper method for equals(Object) that can also be used by subclasses that implement equals(Object). It assumes that the argument is not null.