com.bea.wli.config.customization

Class ReferenceCustomization

java.lang.Object

com.bea.wli.config.customization.Customization

com.bea.wli.config.customization.ReferenceCustomization

All Implemented Interfaces:

java.io.Serializable

public class ReferenceCustomization
extends Customization

Customization for mapping references found in resources to other references.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ReferenceCustomization(java.util.Set<Ref> targets, java.lang.String description, java.util.Map<Ref,Ref> mapping) Deprecated. Use ReferenceCustomization(String, Set<Ref>, Map<Ref, Ref>) instead
ReferenceCustomization(java.lang.String description, java.util.Set<Ref> targets, java.util.Map<Ref,Ref> mapping) Creates a customization for changing/mapping references embedded in a set of resources

Method Summary

Methods

Modifier and Type	Method and Description
Customization	clone(java.util.Set<Ref> filter) Returns a copy of this customization and optionally modifies its target references so that the customization only applies to a reference if it is subsumed by a reference in the filter.
java.util.Map<Ref,Ref>	getMapping() Returns the reference mapping to be applied.
java.util.Set<Ref>	getTargets() Returns the references to resources, folders or projects which the customizations will be applied to.
CustomizationType	toXML() Returns an xml representation for this customization

Methods inherited from class com.bea.wli.config.customization.Customization

fromXML, fromXML, fromXML, getDescription, toXML, toXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ReferenceCustomization

@Deprecated
public ReferenceCustomization(java.util.Set<Ref> targets,
                                 java.lang.String description,
                                 java.util.Map<Ref,Ref> mapping)

Deprecated. Use ReferenceCustomization(String, Set<Ref>, Map<Ref, Ref>) instead

ReferenceCustomization

public ReferenceCustomization(java.lang.String description,
                      java.util.Set<Ref> targets,
                      java.util.Map<Ref,Ref> mapping)

Creates a customization for changing/mapping references embedded in a set of resources

Parameters:

description - the user given description for this customization

targets - resources to consider. A null value indicates all resources. A project or folder resource indicates all resources in that project / folder.

mapping - mapping from old references to be modified to their new values

Method Detail

getTargets

public java.util.Set<Ref> getTargets()

Description copied from class: Customization

Returns the references to resources, folders or projects which the customizations will be applied to.

Specified by:

getTargets in class Customization

Returns:

the references which the customizations will be applied to

getMapping

public java.util.Map<Ref,Ref> getMapping()

Returns the reference mapping to be applied.

Returns:

the reference mapping

clone

public Customization clone(java.util.Set<Ref> filter)

Description copied from class: Customization

Returns a copy of this customization and optionally modifies its target references so that the customization only applies to a reference if it is subsumed by a reference in the filter. This operation essentially applies the customization to a smaller set of references. The target references is filtered so that one of the following happens:

• if a target reference is in the filter then it is kept in the clone as well.
• otherwise if a target reference is under a project/folder specified in the filter then it is kept in the clone.
• otherwise, if there is a reference in the filter, that is under a target reference (for example filter contains folder a/b/c, and target contains project a) then the target reference (project a) is replaced with the filter reference (folder a/b/c), effectively narrowing the target reference to a more specific reference.
• otherwise the target reference is removed.

Specified by:

clone in class Customization

Parameters:

filter - if filter is null no narrowing is performed, and the customization is cloned as-is.

Returns:

the copy of this customization

toXML

public CustomizationType toXML()
                        throws XmlException

Description copied from class: Customization

Returns an xml representation for this customization

Specified by:

toXML in class Customization

Returns:

the xml document

Throws:

XmlException