Class DescriptorTag
- java.lang.Object
-
- org.codehaus.plexus.metadata.merge.support.DescriptorTag
-
- Direct Known Subclasses:
PlexusXmlTag
public class DescriptorTag extends java.lang.Object
Represents the various top-level tags in a deployment descriptor as a typesafe enumeration.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.Class
mergeableClass
Class that wraps this tag and provides for merging same tags.private boolean
multipleAllowed
Whether multiple occurrences of the tag in the descriptor are allowed.private java.lang.String
tagName
The tag name.
-
Constructor Summary
Constructors Constructor Description DescriptorTag(java.lang.String tagName)
Constructor.DescriptorTag(java.lang.String tagName, boolean isMultipleAllowed)
Deprecated.UseDescriptorTag(String,boolean,Class)
insteadDescriptorTag(java.lang.String tagName, boolean isMultipleAllowed, java.lang.Class mergeableClass)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Mergeable
createMergeable(org.jdom2.Element element)
Creates anMergeable
instance from the registered class for this tag instance.boolean
equals(java.lang.Object other)
java.lang.String
getTagName()
int
hashCode()
boolean
isMergeable()
Determines if a particular Tag is mergeable or not.boolean
isMultipleAllowed()
Returns whether the tag may occur multiple times in the descriptor.java.lang.String
toString()
-
-
-
Field Detail
-
tagName
private java.lang.String tagName
The tag name.
-
multipleAllowed
private boolean multipleAllowed
Whether multiple occurrences of the tag in the descriptor are allowed.
-
mergeableClass
private java.lang.Class mergeableClass
Class that wraps this tag and provides for merging same tags.
-
-
Constructor Detail
-
DescriptorTag
public DescriptorTag(java.lang.String tagName)
Constructor.- Parameters:
tagName
- The tag name of the element
-
DescriptorTag
public DescriptorTag(java.lang.String tagName, boolean isMultipleAllowed)
Deprecated.UseDescriptorTag(String,boolean,Class)
insteadConstructor.- Parameters:
tagName
- The tag name of the elementisMultipleAllowed
- Whether the element may occur multiple times in the descriptor
-
DescriptorTag
public DescriptorTag(java.lang.String tagName, boolean isMultipleAllowed, java.lang.Class mergeableClass)
Constructor.- Parameters:
tagName
- The tag name of the elementisMultipleAllowed
- Whether the element may occur multiple times in the descriptormergeableClass
- Concrete implementation ofMergeable
that is bound this tag.
-
-
Method Detail
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getTagName
public java.lang.String getTagName()
-
isMultipleAllowed
public boolean isMultipleAllowed()
Returns whether the tag may occur multiple times in the descriptor.- Returns:
- Whether multiple occurrences are allowed
-
isMergeable
public boolean isMergeable()
Determines if a particular Tag is mergeable or not.Basically means if we have a
Mergeable
class registered for a tag instance.- Returns:
true
if this tag is mergeable.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
createMergeable
public Mergeable createMergeable(org.jdom2.Element element) throws java.lang.Exception
Creates anMergeable
instance from the registered class for this tag instance.- Parameters:
element
-Element
.- Returns:
- instance of
Mergeable
. - Throws:
java.lang.Exception
- if there was an error creating an instance.
-
-