public abstract class TopLevelDefinition extends Definition
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DESCRIPTION_KEY
The key for the description of a bean or bean property.
|
static java.lang.String |
LABEL_KEY
The key for the label of a bean or bean property.
|
Modifier and Type | Method and Description |
---|---|
void |
addDeprecatedId(java.lang.String id) |
java.lang.String |
bind(java.lang.String message,
java.lang.Object context,
boolean erase)
Binds a template resource string in the context of an object.
|
java.lang.String |
description()
Gets the localized description of a defined bean, or null if none.
|
boolean |
equals(java.lang.Object that) |
java.lang.String |
formattedString(java.lang.String name,
java.lang.Object context)
Gets a localized string for a defined bean.
|
java.lang.String |
formattedString(java.lang.String name,
java.lang.Object context,
boolean erase)
Gets a localized string for a defined bean.
|
java.util.List<java.lang.String> |
getDeprecatedIds() |
java.lang.String |
getElementName() |
ExtensionBundle |
getExtensionBundle() |
java.lang.String |
getId() |
java.lang.String |
getName() |
java.util.Map<java.lang.String,java.lang.String> |
getStrings() |
int |
hashCode() |
java.lang.String |
label()
Gets the localized label of a defined bean, or the id if none.
|
protected java.lang.String |
missingLabel()
Handles a missing label string.
|
protected void |
missingString(java.lang.String kind)
Handles a missing string.
|
java.lang.String |
propertyDescription(java.lang.String propertyName)
Gets the localized description of a property of a defined bean, or null if
none.
|
java.lang.String |
propertyLabel(java.lang.String propertyName)
Gets the localized label of a property of a defined bean, or null if none.
|
java.lang.String |
propertyString(java.lang.String propertyName,
java.lang.String kind)
Gets a localized string for a property of a defined bean.
|
void |
setStrings(java.util.Map<java.lang.String,java.lang.String> strings) |
java.lang.String |
string(java.lang.String kind)
Gets a resource string for a defined bean.
|
java.lang.String |
toString() |
getColumnNumber, getContext, getExtensionId, getLineNumber, getPublicId, getSystemId, isExtensionLoaded, log, log
public static final java.lang.String LABEL_KEY
public static final java.lang.String DESCRIPTION_KEY
public ExtensionBundle getExtensionBundle()
public java.lang.String getId()
public java.lang.String getName()
public java.util.List<java.lang.String> getDeprecatedIds()
public void addDeprecatedId(java.lang.String id)
public java.util.Map<java.lang.String,java.lang.String> getStrings()
public void setStrings(java.util.Map<java.lang.String,java.lang.String> strings)
public java.lang.String label()
LABEL_KEY
public java.lang.String description()
DESCRIPTION_KEY
public java.lang.String propertyLabel(java.lang.String propertyName)
LABEL_KEY
public java.lang.String propertyDescription(java.lang.String propertyName)
DESCRIPTION_KEY
public java.lang.String string(java.lang.String kind)
The default TopLevelDefinition
implementation obtains the resource
string from the ExtensionBundle
bound to this definition.
kind
- the bean-defined kind of resource string to get (e.g., "label").protected java.lang.String missingLabel()
protected void missingString(java.lang.String kind)
kind
- the bean-defined kind of resource string that is missing (e.g., "label").public java.lang.String formattedString(java.lang.String name, java.lang.Object context)
name
- bean-defined name of the localized string to get (e.g., "label").context
- context defining parameters in the string.public java.lang.String formattedString(java.lang.String name, java.lang.Object context, boolean erase)
name
- bean-defined name of the localized string to get (e.g., "label").context
- context defining parameters in the string.erase
- whether to erase unsatisfied parameter referencespublic java.lang.String propertyString(java.lang.String propertyName, java.lang.String kind)
kind
- the bean-defined kind of resource string to get (e.g., "label").propertyName
- the name of the property.public java.lang.String bind(java.lang.String message, java.lang.Object context, boolean erase)
getValue(java.lang.String, int, int, java.lang.Object)
with the
property name and the context object. Note that getValue
has
special handling for instances of TransformContext
, Violation
, and Map
.
If erase
is true and getValue
returns null for a property,
the immediately surrounding pairs of single or double quotes are erased and
extra spaces are collapsed. This behavior in many cases allows a template
string to instantiate acceptably both when properties are available and
when they are not.
public java.lang.String getElementName()
public boolean equals(java.lang.Object that)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class Definition