oracle.jdeveloper.deploy.common

Class SelectedProjectFiles

java.lang.Object

oracle.ide.model.DefaultDirtyable

oracle.jdeveloper.deploy.DefaultLinkedDirtyable

oracle.jdeveloper.deploy.common.SelectedProjectFiles

All Implemented Interfaces:

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

public final class SelectedProjectFiles
extends DefaultLinkedDirtyable
implements Copyable

Data model that represents a group of files that are in the project that are selected (or deselected) to be involved in deployment.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AS_BOTH_COMPILED_OUTPUT_AND_SOURCE_FILES
static int	AS_COMPILED_OUTPUT_ONLY
static int	AS_SOURCE_FILES_ONLY

Constructor Summary

Constructors

Constructor and Description
SelectedProjectFiles()
SelectedProjectFiles(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(SelectedProjectFiles copy) Design pattern for supporting strongly typed copying.
boolean	equals(java.lang.Object o)
protected boolean	equalsImpl(SelectedProjectFiles spf) This is a helper method for equals(Object) that can also be used by subclasses that implement equals(Object).
int	getDeploySourceAs()
java.net.URL[]	getFiles() When isAutoInclude() is true, the files property represents those files that are excluded; but when isAutoInclude() is false, the files property represents files that are included.
HashStructure	getHashStructure()
java.lang.Class[]	getSelectionFilters() The strings returned by getSelectionFilters() comprise a list of Java classes for objects that implement a filtering mechanism for project file selection.
boolean	isAutoInclude() If true, this flag indicates that project files should be included automatically whenever a new one is added to the project.
void	setAutoInclude(boolean b) If true, this flag indicates that project files should be included automatically whenever a new one is added to the project.
void	setDeploySourceAs(int deploySourceAs)
void	setFiles(java.net.URL[] files) When isAutoInclude() is true, the files property represents those files that are excluded; but when isAutoInclude() is false, the files property represents files that are included.
void	setSelectionFilters(java.lang.Class[] selectionFilters) The strings accepted by setSelectionFilters() comprise a list of Java classes for objects that implement a filtering mechanism for project file selection.

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

Field Detail

AS_COMPILED_OUTPUT_ONLY

public static final int AS_COMPILED_OUTPUT_ONLY

See Also:

Constant Field Values

AS_SOURCE_FILES_ONLY

public static final int AS_SOURCE_FILES_ONLY

See Also:

Constant Field Values

AS_BOTH_COMPILED_OUTPUT_AND_SOURCE_FILES

public static final int AS_BOTH_COMPILED_OUTPUT_AND_SOURCE_FILES

See Also:

Constant Field Values

Constructor Detail

SelectedProjectFiles

public SelectedProjectFiles()

SelectedProjectFiles

public SelectedProjectFiles(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(SelectedProjectFiles copy)

Design pattern for supporting strongly typed copying.

isAutoInclude

public boolean isAutoInclude()

If true, this flag indicates that project files should be included automatically whenever a new one is added to the project.

setAutoInclude

public void setAutoInclude(boolean b)

If true, this flag indicates that project files should be included automatically whenever a new one is added to the project.

getFiles

public java.net.URL[] getFiles()

When isAutoInclude() is true, the files property represents those files that are excluded; but when isAutoInclude() is false, the files property represents files that are included. Because the complete list of files available is specific to the design-time environment, it is the responsibility of the design-time code to perform the inversion of the files property whenever the isAutoInclude() flag is flipped.

setFiles

public void setFiles(java.net.URL[] files)

When isAutoInclude() is true, the files property represents those files that are excluded; but when isAutoInclude() is false, the files property represents files that are included. Because the complete list of files available is specific to the design-time environment, it is the responsibility of the design-time code to perform the inversion of the files property whenever the isAutoInclude() flag is flipped.

getSelectionFilters

public java.lang.Class[] getSelectionFilters()

The strings returned by getSelectionFilters() comprise a list of Java classes for objects that implement a filtering mechanism for project file selection. The exact behavior of the filtering mechanism is dependent on the particular design-time implementation. In JDeveloper, the filters are classes that implement oracle.jdeveloper.deploy.common.dt.ProjectSelectionFilter.

setSelectionFilters

public void setSelectionFilters(java.lang.Class[] selectionFilters)

The strings accepted by setSelectionFilters() comprise a list of Java classes for objects that implement a filtering mechanism for project file selection. The exact behavior of the filtering mechanism is dependent on the particular design-time implementation. In JDeveloper, the filters are classes that implement oracle.jdeveloper.deploy.common.dt.ProjectSelectionFilter.

getDeploySourceAs

public int getDeploySourceAs()

setDeploySourceAs

public void setDeploySourceAs(int deploySourceAs)

getHashStructure

public HashStructure getHashStructure()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equalsImpl

protected final boolean equalsImpl(SelectedProjectFiles spf)

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.