|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.dna.graph.property.basic.BasicProperty
@Immutable public abstract class BasicProperty
Constructor Summary | |
---|---|
BasicProperty(Name name)
|
Method Summary | |
---|---|
int |
compareTo(Property that)
|
boolean |
equals(Object obj)
|
Name |
getName()
Get the name of the property. |
String |
getString()
Get the string form of the property, using the default encoder. |
String |
getString(NamespaceRegistry namespaceRegistry)
Get the string form of the property, using the supplied namespace registry to convert the property's name and values. |
String |
getString(NamespaceRegistry namespaceRegistry,
TextEncoder encoder)
Get the encoded string form of the property, using the supplied namespace registry to convert the property's namespace URIs to prefixes and the supplied encoder to encode characters in the property's name and values. |
String |
getString(NamespaceRegistry namespaceRegistry,
TextEncoder encoder,
TextEncoder delimiterEncoder)
Get the encoded string form of the property, using the supplied namespace registry to convert the property's namespace URIs to prefixes and the supplied encoder to encode characters in the property's name and values. |
String |
getString(TextEncoder encoder)
Get the encoded string form of the property, using the supplied encoder to encode characters in the property's name and values. |
Iterator<?> |
getValues()
Obtain the property's values in their natural form. |
Object[] |
getValuesAsArray()
Obtain the property's values as an array of objects in their natural form. |
int |
hashCode()
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.jboss.dna.graph.property.Property |
---|
getFirstValue, isEmpty, isMultiple, isSingle, size |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Constructor Detail |
---|
public BasicProperty(Name name)
name
- Method Detail |
---|
public Name getName()
getName
in interface Property
public Iterator<?> getValues()
iterator()
.
A valid iterator is returned if the property has single valued
or multi-valued
.
The resulting iterator is immutable, and all property values are immutable.
getValues
in interface Property
Property.getFirstValue()
,
Iterable.iterator()
,
Property.getValuesAsArray()
,
ValueFactory.create(Iterator)
public Object[] getValuesAsArray()
A valid array is return if the property has single valued
or multi-valued
, or a
null value is returned if the property is empty
.
The resulting array is a copy, guaranteeing immutability for the property.
getValuesAsArray
in interface Property
Property.getFirstValue()
,
Iterable.iterator()
,
Property.getValues()
,
ValueFactory.create(Object[])
public int compareTo(Property that)
compareTo
in interface Comparable<Property>
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
public String getString()
getString
in interface Property
Property.getString(TextEncoder)
public String getString(TextEncoder encoder)
getString
in interface Property
encoder
- the encoder to use, or null if the default encoder should be used
Property.getString()
public String getString(NamespaceRegistry namespaceRegistry)
getString
in interface Property
namespaceRegistry
- the namespace registry that should be used to obtain the prefix for the
namespace URIs
in the property name
Property.getString(NamespaceRegistry,TextEncoder)
,
Property.getString(NamespaceRegistry, TextEncoder, TextEncoder)
public String getString(NamespaceRegistry namespaceRegistry, TextEncoder encoder)
getString
in interface Property
namespaceRegistry
- the namespace registry that should be used to obtain the prefix for the
namespace URIs
in the property name
, or null if the namespace
registry should not be usedencoder
- the encoder to use for encoding the name and values, or null if the default encoder should be used
Property.getString(NamespaceRegistry)
,
Property.getString(NamespaceRegistry, TextEncoder, TextEncoder)
public String getString(NamespaceRegistry namespaceRegistry, TextEncoder encoder, TextEncoder delimiterEncoder)
getString
in interface Property
namespaceRegistry
- the namespace registry that should be used to obtain the prefix for the
namespace URIs
in the property name
, or null if the namespace
registry should not be usedencoder
- the encoder to use for encoding the name and values, or null if the default encoder should be useddelimiterEncoder
- the encoder to use for encoding delimiters used in paths and names, or null if the standard
delimiters should be used
Path.getString(org.jboss.dna.graph.property.NamespaceRegistry,
org.jboss.dna.common.text.TextEncoder, org.jboss.dna.common.text.TextEncoder)
public String toString()
toString
in class Object
Object.toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |