com.bea.wli.config.customization
Class FindAndReplaceCustomization

java.lang.Object
  extended by com.bea.wli.config.customization.Customization
      extended by com.bea.wli.config.customization.FindAndReplaceCustomization
All Implemented Interfaces:
Serializable

public class FindAndReplaceCustomization
extends Customization

Customization for modifying environment values by doing string substitutions.

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Constructor Summary
FindAndReplaceCustomization(String description, EnvValueQuery query, String replacement)
          Constructor for creating a find-and-replace customization
 
Method Summary
 Customization clone(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.
 EnvValueQuery getQuery()
           
 String getReplacement()
           
 Set<Ref> getTargets()
          Returns the references to resources, folders or projects which the customizations will be applied to.
 org.apache.xmlbeans.XmlObject toXML()
          Returns an xml representation for this customization
 
Methods inherited from class com.bea.wli.config.customization.Customization
fromXML, fromXML, getDescription, 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

FindAndReplaceCustomization

public FindAndReplaceCustomization(String description,
                                   EnvValueQuery query,
                                   String replacement)
Constructor for creating a find-and-replace customization

Parameters:
query - the query that indicates which env values to find
description - the user given description for this customization
replacement - the replacement text. This text will be substituted for the env value pattern given in the query.
Method Detail

getQuery

public EnvValueQuery getQuery()

getReplacement

public String getReplacement()

getTargets

public 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:

toXML

public org.apache.xmlbeans.XmlObject toXML()
                                    throws org.apache.xmlbeans.XmlException
Description copied from class: Customization
Returns an xml representation for this customization

Specified by:
toXML in class Customization
Returns:
Throws:
org.apache.xmlbeans.XmlException

clone

public Customization clone(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: