oracle.jdeveloper.deploy.common

Class LibraryFileGroup

java.lang.Object

oracle.ide.model.DefaultDirtyable

oracle.jdeveloper.deploy.DefaultLinkedDirtyable

oracle.jdeveloper.deploy.common.FileGroup

oracle.jdeveloper.deploy.common.LibraryFileGroup

All Implemented Interfaces:

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

public class LibraryFileGroup
extends FileGroup

A file group that represents library selections.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARCHIVES_AS_FILES Constant that means that selected libraries should be deployed as the jar files themselves.
static int	ARCHIVES_AS_VIRTUAL_DIRECTORIES Constant that means that the selected libraries should collectively serve as a virtual path from which files will be extracted and repackaged during deployment.
static java.lang.String	DEFAULT_INTERNAL_NAME
static java.lang.String	SELECTED_LIBRARIES
static java.lang.String	UNSELECTED_LIBRARIES

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
LibraryFileGroup()
LibraryFileGroup(HashStructure hash)
LibraryFileGroup(java.lang.String displayName)
LibraryFileGroup(java.lang.String displayName, java.lang.String internalName)

Method Summary

Methods

Modifier and Type	Method and Description
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(LibraryFileGroup group, java.util.List<JLibrary> deployedLibs) Returns a URLPath given a LibraryFileGroup and a list of dependent libraries.
SelectionRules	getFilters()
java.lang.String[]	getSelectedLibraries() Returns the the list of libraries that are explicitly selected as contributors for this file group.
int	getSelectionMode() Returns one of: ARCHIVES_AS_FILES ARCHIVES_AS_VIRTUAL_DIRECTORIES
URLPath	getSourceRoots(Profile profile) Deprecated.
java.lang.String[]	getUnselectedLibraries() Returns the the list of libraries that are explicitly unselected from being contributors for this file group.
static LibraryFileGroup	newDefaultGroup(java.lang.String displayName)
void	selectLibrary(java.lang.String id) Checks to see if a id was previously unselected, if so removes it from the unselected list, else adds the specified library to the list of unique selected libraries.
void	setFilters(SelectionRules filters)
void	setSelectedLibraries(java.lang.String[] selectedLibraries)
void	setSelectionMode(int selectionMode) The specified int must be one of: ARCHIVES_AS_FILES ARCHIVES_AS_VIRTUAL_DIRECTORIES
void	setUnselectedLibraries(java.lang.String[] unselectedLibraries)
int	type()
void	unselectLibrary(java.lang.String id) Checks to see if a id was previously selected, if so removes it from the selected list, else adds the specified library to the list of unique unselected libraries.

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

SELECTED_LIBRARIES

public static final java.lang.String SELECTED_LIBRARIES

See Also:

Constant Field Values

UNSELECTED_LIBRARIES

public static final java.lang.String UNSELECTED_LIBRARIES

See Also:

Constant Field Values

ARCHIVES_AS_FILES

public static final int ARCHIVES_AS_FILES

Constant that means that selected libraries should be deployed as the jar files themselves.

See Also:

Constant Field Values

ARCHIVES_AS_VIRTUAL_DIRECTORIES

public static final int ARCHIVES_AS_VIRTUAL_DIRECTORIES

Constant that means that the selected libraries should collectively serve as a virtual path from which files will be extracted and repackaged during deployment.

See Also:

Constant Field Values

Constructor Detail

LibraryFileGroup

public LibraryFileGroup()

LibraryFileGroup

public LibraryFileGroup(HashStructure hash)

LibraryFileGroup

public LibraryFileGroup(java.lang.String displayName)

LibraryFileGroup

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

Method Detail

newDefaultGroup

public static LibraryFileGroup newDefaultGroup(java.lang.String displayName)

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.

getSelectedLibraries

public java.lang.String[] getSelectedLibraries()

Returns the the list of libraries that are explicitly selected as contributors for this file group. The returned array does *not* include libraries that are implicit contributors because the library itself is marked as "deployed by default".

setSelectedLibraries

public void setSelectedLibraries(java.lang.String[] selectedLibraries)

getUnselectedLibraries

public java.lang.String[] getUnselectedLibraries()

Returns the the list of libraries that are explicitly unselected from being contributors for this file group. The returned array does *not* include libraries that are implicitly excluded because the library itself is NOT marked as "deployed by default".

setUnselectedLibraries

public void setUnselectedLibraries(java.lang.String[] unselectedLibraries)

selectLibrary

public void selectLibrary(java.lang.String id)

Checks to see if a id was previously unselected, if so removes it from the unselected list, else adds the specified library to the list of unique selected libraries.

unselectLibrary

public void unselectLibrary(java.lang.String id)

Checks to see if a id was previously selected, if so removes it from the selected list, else adds the specified library to the list of unique unselected libraries.

getSelectionMode

public int getSelectionMode()

Returns one of:

• ARCHIVES_AS_FILES
• ARCHIVES_AS_VIRTUAL_DIRECTORIES

setSelectionMode

public void setSelectionMode(int selectionMode)

The specified int must be one of:

• ARCHIVES_AS_FILES
• ARCHIVES_AS_VIRTUAL_DIRECTORIES

getFilters

public SelectionRules getFilters()

setFilters

public void setFilters(SelectionRules filters)

getSourceRoots

@Deprecated
public URLPath getSourceRoots(Profile profile)

Deprecated.

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 URLs from all selected library dependencies (including those from dependent projects and/or profiles. This should be the same list as if you were to open the fileGroup in the profile editor and navigate to its filter section):

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 as well as other relevant information.

Returns:

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

getContribPath

public static URLPath getContribPath(LibraryFileGroup group,
                     java.util.List<JLibrary> deployedLibs)

Returns a URLPath given a LibraryFileGroup and a list of dependent libraries. This method will use the given libraries to construct a URLPath and return it.

Parameters:

group - The LibraryFileGroup. It is used to properly process the libraries given it's selectionMode.

deployedLibs - The Dependent Libraries that should be used to construct a URLPath.

Returns:

The resulting URLPath.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class FileGroup