public abstract class Customization extends Object implements Serializable
Modifier and Type | Field and Description |
---|---|
static long |
serialVersionUID |
Modifier and Type | Method and Description |
---|---|
abstract 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.
|
static List<Customization> |
fromXML(CustomizationsDocument customizationsDocument)
Deprecated.
use
Customization.fromXML(InputStream, SchemaTypeLoader) instead |
static List<Customization> |
fromXML(InputStream is, SchemaTypeLoader customTypeLoader)
Parses given input stream that contains the serialized xml represention and returns list of customizations.
|
static Customization |
fromXML(XmlObject xml)
Deprecated.
use
Customization.fromXML(InputStream, SchemaTypeLoader) instead |
String |
getDescription()
Returns the user given description for this customization
|
abstract Set<Ref> |
getTargets()
Returns the references to resources, folders or projects which the customizations will be applied to.
|
abstract CustomizationType |
toXML()
Returns an xml representation for this customization
|
static CustomizationsDocument |
toXML(List<Customization> customizations)
Converts the give list of customization into an xml form.
|
static void |
toXML(List<Customization> customizations, OutputStream os)
Converts the give list of customization into an xml form and serializes to the given stream.
|
public static final long serialVersionUID
public String getDescription()
public abstract Set<Ref> getTargets()
public abstract Customization clone(Set<Ref> filter)
filter
- if filter is null no narrowing is performed, and the customization is cloned as-is.public abstract CustomizationType toXML() throws XmlException
XmlException
@Deprecated public static Customization fromXML(XmlObject xml) throws UnknownCustomizationTypeException, CustomizationValidationException
Customization.fromXML(InputStream, SchemaTypeLoader)
insteadCustomization.fromXML(InputStream, SchemaTypeLoader)
.xml
- the xml representation of a customizationUnknownCustomizationTypeException
- the xml is for an unsupported customization typeCustomizationValidationException
- the XML document is invalidpublic static List<Customization> fromXML(InputStream is, SchemaTypeLoader customTypeLoader) throws IOException, XmlException, UnknownCustomizationTypeException, CustomizationValidationException
is
- input stream that provides the xml document containing a list of customizationscustomTypeLoader
- a schema type loader to use when parsing the input stream (for any custom schema types) (may be null)UnknownCustomizationTypeException
- the xml is for an unsupported customization typeCustomizationValidationException
- the XML document is invalidIOException
XmlException
@Deprecated public static List<Customization> fromXML(CustomizationsDocument customizationsDocument) throws UnknownCustomizationTypeException, CustomizationValidationException
Customization.fromXML(InputStream, SchemaTypeLoader)
insteadCustomization.fromXML(InputStream, SchemaTypeLoader)
.customizationsDocument
- the xml document containing a list of customizationsUnknownCustomizationTypeException
- the xml is for an unsupported customization typeCustomizationValidationException
- the XML document is invalidpublic static CustomizationsDocument toXML(List<Customization> customizations) throws XmlException
customizations
- the list of customizationsXmlException
public static void toXML(List<Customization> customizations, OutputStream os) throws IOException, XmlException
customizations
- the list customizationsos
- where to serialize the xml formIOException
XmlException