Top Description Fields Constructors Methods
com.fasterxml.jackson.databind

public Class PropertyName

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
com.fasterxml.jackson.core.SerializableString, com.fasterxml.jackson.core.io.SerializedString, com.fasterxml.jackson.core.util.InternCache, com.fasterxml.jackson.databind.cfg.MapperConfig, com.fasterxml.jackson.databind.util.ClassUtil, java.util.Objects

Simple value class used for containing names of properties as defined by annotations (and possibly other configuration sources).
Since
2.1

Field Summary

Modifier and TypeField and Description
protected SerializableString
_encodedSimple

Lazily-constructed efficient representation of the simple name.

protected final String
_namespace

Additional namespace, for formats that have such concept (JSON does not, XML does, for example).

private static final String
protected final String
_simpleName

Basic name of the property.

private static final String
public static final PropertyName
NO_NAME

Special placeholder value that indicates that there is no name associated.

private static final long
public static final PropertyName
USE_DEFAULT

Special placeholder value that indicates that name to use should be based on the standard heuristics.

Constructor Summary

AccessConstructor and Description
public
PropertyName(String simpleName)

public
PropertyName(String simpleName, String namespace)

Method Summary

Modifier and TypeMethod and Description
public static PropertyName
construct(String simpleName)

public static PropertyName
construct(String simpleName, String ns)

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
public boolean
public boolean
public PropertyName
public boolean
isEmpty()

Method that is basically equivalent of:

   !hasSimpleName() << !hasNamespace();
protected Object
public SerializableString
simpleAsEncoded(MapperConfig<?> config)

Accessor that may be used to get lazily-constructed efficient representation of the simple name.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public PropertyName
withNamespace(String ns)

Fluent factory method for constructing an instance with different namespace.

public PropertyName
withSimpleName(String simpleName)

Fluent factory method for constructing an instance with different simple name.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

_encodedSimpleback to summary
protected SerializableString _encodedSimple

Lazily-constructed efficient representation of the simple name.

Note

not defined as volatile to avoid performance problem with concurrent access in multi-core environments; due to statelessness of SerializedString at most leads to multiple instantiations.

Since
2.4
_namespaceback to summary
protected final String _namespace

Additional namespace, for formats that have such concept (JSON does not, XML does, for example).

_NO_NAMEback to summary
private static final String _NO_NAME
_simpleNameback to summary
protected final String _simpleName

Basic name of the property.

_USE_DEFAULTback to summary
private static final String _USE_DEFAULT
NO_NAMEback to summary
public static final PropertyName NO_NAME

Special placeholder value that indicates that there is no name associated. Exact semantics to use (if any) depend on actual annotation in use, but commonly this value disables behavior for which name would be needed.

serialVersionUIDback to summary
private static final long serialVersionUID
USE_DEFAULTback to summary
public static final PropertyName USE_DEFAULT

Special placeholder value that indicates that name to use should be based on the standard heuristics. This can be different from returning null, as null means "no information available, whereas this value indicates explicit defaulting.

Constructor Detail

PropertyNameback to summary
public PropertyName(String simpleName)
PropertyNameback to summary
public PropertyName(String simpleName, String namespace)

Method Detail

constructback to summary
public static PropertyName construct(String simpleName)
Since
2.6
constructback to summary
public static PropertyName construct(String simpleName, String ns)
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getNamespaceback to summary
public String getNamespace()
getSimpleNameback to summary
public String getSimpleName()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
hasNamespaceback to summary
public boolean hasNamespace()
hasSimpleNameback to summary
public boolean hasSimpleName()
hasSimpleNameback to summary
public boolean hasSimpleName(String str)
Since
2.3
internSimpleNameback to summary
public PropertyName internSimpleName()
isEmptyback to summary
public boolean isEmpty()

Method that is basically equivalent of:

   !hasSimpleName() << !hasNamespace();
Since
2.4
readResolveback to summary
protected Object readResolve()
simpleAsEncodedback to summary
public SerializableString simpleAsEncoded(MapperConfig<?> config)

Accessor that may be used to get lazily-constructed efficient representation of the simple name.

Since
2.4
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
withNamespaceback to summary
public PropertyName withNamespace(String ns)

Fluent factory method for constructing an instance with different namespace.

withSimpleNameback to summary
public PropertyName withSimpleName(String simpleName)

Fluent factory method for constructing an instance with different simple name.