oracle.jdeveloper.deploy.common

Class PackagingFileGroup

java.lang.Object

oracle.ide.model.DefaultDirtyable

oracle.jdeveloper.deploy.DefaultLinkedDirtyable

oracle.jdeveloper.deploy.common.FileGroup

oracle.jdeveloper.deploy.common.PackagingFileGroup

All Implemented Interfaces:

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

public final class PackagingFileGroup
extends FileGroup

FileGroup that represents packaging instructions that apply a set of filters to a set of initial contributors. There is no dependency analysis of any of the selections.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_INTERNAL_NAME

Fields inherited from class oracle.jdeveloper.deploy.common.FileGroup

_hash, LIBRARY_FILE_GROUP, MODULE_FILE_GROUP, PACKAGING_FILE_GROUP, PROJECT_FILE_GROUP

Constructor Summary

Constructors

Constructor and Description
PackagingFileGroup()
PackagingFileGroup(HashStructure hash)
PackagingFileGroup(java.lang.String displayName, java.lang.String internalName)

Method Summary

Modifier and Type	Method and Description
void	addContributor(Contributor contributor) Deprecated. Use getContributorList().addContributor() instead.
java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
boolean	equals(java.lang.Object o)
static URLPath	getContribPath(PackagingFileGroup group, DataContainer container) Deprecated.
Contributors	getContributorList() Returns the list of contributors.
Contributor[]	getContributors() Deprecated.
java.util.List	getContributorsByType(int type) Deprecated. Use getContributorsList() instead.
SelectionRules	getFilters()
URLPath	getSourceRoots(Profile profile) Returns the source roots for the fileGroup.
static PackagingFileGroup	newDefaultGroup()
static PackagingFileGroup	newDefaultGroup(java.lang.Class profileContainerClass)
static PackagingFileGroup	newDefaultGroup(java.lang.Class profileContainerClass, java.lang.String displayName, java.lang.String internalName)
static PackagingFileGroup	newDefaultGroup(java.lang.String displayName, java.lang.String internalName)
static PackagingFileGroup	newEmptyGroup(java.lang.String displayName, java.lang.String internalName)
void	setContributorList(Contributors contributors)
void	setContributors(Contributor[] contributors)
void	setFilters(SelectionRules filters)
int	type()

Methods inherited from class oracle.jdeveloper.deploy.common.FileGroup

copyToImpl, equalsImpl, getDisplayName, getHashStructure, getInternalName, getTargetWithinJar, hasInternalName, setDisplayName, setInternalName, setTargetWithinJar, toPathWithinJar

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

DEFAULT_INTERNAL_NAME

public static final java.lang.String DEFAULT_INTERNAL_NAME

See Also:

Constant Field Values

Constructor Detail

PackagingFileGroup

public PackagingFileGroup()

PackagingFileGroup

public PackagingFileGroup(HashStructure hash)

PackagingFileGroup

public PackagingFileGroup(java.lang.String displayName,
                          java.lang.String internalName)

Method Detail

newDefaultGroup

public static PackagingFileGroup newDefaultGroup()

newDefaultGroup

public static PackagingFileGroup newDefaultGroup(java.lang.Class profileContainerClass)

newDefaultGroup

public static PackagingFileGroup newDefaultGroup(java.lang.String displayName,
                                                 java.lang.String internalName)

newDefaultGroup

public static PackagingFileGroup newDefaultGroup(java.lang.Class profileContainerClass,
                                                 java.lang.String displayName,
                                                 java.lang.String internalName)

newEmptyGroup

public static PackagingFileGroup newEmptyGroup(java.lang.String displayName,
                                               java.lang.String internalName)

type

public final int type()

Specified by:

type in class FileGroup

Returns:

#PACKAGING_GROUP or #PROJECT_SELECTION_GROUP, depending on what the subclass type is.

copyTo

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

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

Specified by:

copyTo in class FileGroup

Parameters:

target - 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.

getContributors

@Deprecated
public Contributor[] getContributors()

Deprecated.

getContributorList

public Contributors getContributorList()

Returns the list of contributors.

Returns:

null if not set.

setContributorList

public void setContributorList(Contributors contributors)

Parameters:

contributors -

setContributors

public void setContributors(Contributor[] contributors)

addContributor

@Deprecated
public void addContributor(Contributor contributor)

Deprecated. Use getContributorList().addContributor() instead.

getContributorsByType

@Deprecated
public java.util.List getContributorsByType(int type)

Deprecated. Use getContributorsList() instead.

getFilters

public SelectionRules getFilters()

setFilters

public void setFilters(SelectionRules filters)

getSourceRoots

public URLPath getSourceRoots(Profile profile)

Returns the source roots for the fileGroup. Example : URLPath sourceRoots = getSourceRoots(warProfile); Assuming that the Project that houses this warProfile has a dependency on say JavaProject and that our WebinfClassesFileGroup has "Project Dependencies" selected, the returned URLPath would contain the following URLs: /home/jdeveloper/jdev/mywork/Application1/WebProject/classes /home/jdeveloper/jdev/mywork/Application1/JavaProject/classes

Overrides:

getSourceRoots in class FileGroup

Parameters:

profile - the profile for which you want to get the source/target roots. It is used in order to derive the DataContainer.

Returns:

a URLPath list of roots URL (typically directory or jars) that makeup the source for this filegroup.

getContribPath

@Deprecated
public static URLPath getContribPath(PackagingFileGroup group,
                                                 DataContainer container)

Deprecated.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class FileGroup