oracle.jdeveloper.deploy.common

Class CdaFilter

java.lang.Object

oracle.ide.model.DefaultDirtyable

oracle.jdeveloper.deploy.DefaultLinkedDirtyable

oracle.jdeveloper.deploy.common.CdaFilter

All Implemented Interfaces:

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

public final class CdaFilter
extends DefaultLinkedDirtyable
implements Copyable, java.lang.Comparable

This class encapsulates the notion of a single class dependency analyzer filter. The Comparable interface and the toString() implementation are the key parts of this class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLASS
static int	EXCLUDE
static int	INCLUDE
static int	PACKAGE_TREE
static int	SINGLE_PACKAGE

Constructor Summary

Constructors

Constructor and Description
CdaFilter()
CdaFilter(HashStructure hash)
CdaFilter(int type, int scope, java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) Sorts first by scope.
java.lang.Object	copyTo(java.lang.Object object) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(CdaFilter copy)
boolean	equals(java.lang.Object o)
protected boolean	equalsImpl(CdaFilter filter)
static CdaFilter	excludeClass(java.lang.String name) Factory method.
static CdaFilter	excludePackageTree(java.lang.String name) Factory method.
static CdaFilter	excludeSinglePackage(java.lang.String name) Factory method.
HashStructure	getHashStructure()
java.lang.String	getName()
int	getScope()
int	getType()
static CdaFilter	includeClass(java.lang.String name) Factory method.
static CdaFilter	includePackageTree(java.lang.String name) Factory method.
static CdaFilter	includeSinglePackage(java.lang.String name) Factory method.
void	setName(java.lang.String name)
void	setScope(int scope)
void	setType(int type)
java.lang.String	toString()

Methods inherited from class oracle.jdeveloper.deploy.DefaultLinkedDirtyable

compare, 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, wait, wait, wait

Methods inherited from interface oracle.javatools.data.Dirtyable

isDirty

Field Detail

INCLUDE

public static final int INCLUDE

See Also:

Constant Field Values

EXCLUDE

public static final int EXCLUDE

See Also:

Constant Field Values

PACKAGE_TREE

public static final int PACKAGE_TREE

See Also:

Constant Field Values

SINGLE_PACKAGE

public static final int SINGLE_PACKAGE

See Also:

Constant Field Values

CLASS

public static final int CLASS

See Also:

Constant Field Values

Constructor Detail

CdaFilter

public CdaFilter()

CdaFilter

public CdaFilter(HashStructure hash)

CdaFilter

public CdaFilter(int type,
         int scope,
         java.lang.String name)

Method Detail

includePackageTree

public static CdaFilter includePackageTree(java.lang.String name)

Factory method.

excludePackageTree

public static CdaFilter excludePackageTree(java.lang.String name)

Factory method.

includeSinglePackage

public static CdaFilter includeSinglePackage(java.lang.String name)

Factory method.

excludeSinglePackage

public static CdaFilter excludeSinglePackage(java.lang.String name)

Factory method.

includeClass

public static CdaFilter includeClass(java.lang.String name)

Factory method.

excludeClass

public static CdaFilter excludeClass(java.lang.String name)

Factory method.

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(CdaFilter copy)

compareTo

public int compareTo(java.lang.Object o)

Sorts first by scope. If the scopes are the same and are PACKAGE_TREE, then the name determines the ordering. Otherwise, sorting is attempted second by type. If the types are then same, then the name determines the ordering. This produces an ordering that is consistent with the order in which the filters are applied before, during, and after dependency analysis.

Specified by:

compareTo in interface java.lang.Comparable

Overrides:

compareTo in class DefaultLinkedDirtyable

getType

public int getType()
            throws AttributeMarker

Throws:

AttributeMarker

setType

public void setType(int type)

getScope

public int getScope()
             throws AttributeMarker

Throws:

AttributeMarker

setScope

public void setScope(int scope)

getName

public java.lang.String getName()
                         throws AttributeMarker

Throws:

AttributeMarker

setName

public void setName(java.lang.String name)

getHashStructure

public HashStructure getHashStructure()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equalsImpl

protected final boolean equalsImpl(CdaFilter filter)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object