Jackson 2.18.2 · com.fasterxml.jackson.databind.PropertyName

Field Summary

Modifier and Type	Field 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	_NO_NAME
protected final String	_simpleName Basic name of the property.
private static final String	_USE_DEFAULT
public static final PropertyName	NO_NAME Special placeholder value that indicates that there is no name associated.
private static final long	serialVersionUID
public static final PropertyName	USE_DEFAULT Special placeholder value that indicates that name to use should be based on the standard heuristics.

Constructor Summary

Access	Constructor and Description
public	PropertyName(String simpleName)
public	PropertyName(String simpleName, String namespace)

Method Summary

Modifier and Type	Method and Description
private static String	_nonEmpty(String str1, String str2)
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	getNamespace()
public String	getSimpleName()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasNamespace()
public boolean	hasSimpleName()
public boolean	hasSimpleName(String str)
public PropertyName	internSimpleName()
public boolean	isEmpty() Method that is basically equivalent of: !hasSimpleName() << !hasNamespace();
public static PropertyName	Returns: Merged information; only `null` if both arguments are `null`s. merge(PropertyName Name with higher precedence; may be `null` name1, PropertyName Name with lower precedence; may be `null` name2) Method that will combine information from two `PropertyName` instances
protected Object	readResolve()
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:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

_encodedSimple back to summary

_encodedSimple	back 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

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

_namespace	back to summary
protected final String _namespace Additional namespace, for formats that have such concept (JSON does not, XML does, for example).

_NO_NAME	back to summary
private static final String _NO_NAME

_simpleName	back to summary
protected final String _simpleName Basic name of the property.

_USE_DEFAULT	back to summary
private static final String _USE_DEFAULT

NO_NAME	back 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.

serialVersionUID	back to summary
private static final long serialVersionUID

USE_DEFAULT	back 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

PropertyName	back to summary
public PropertyName(String simpleName)

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

Method Detail

_nonEmpty	back to summary
private static String _nonEmpty(String str1, String str2)

construct	back to summary
public static PropertyName construct(String simpleName) Since 2.6

construct	back to summary
public static PropertyName construct(String simpleName, String ns)

equals back to summary

equals	back 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

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

getNamespace	back to summary
public String getNamespace()

getSimpleName	back to summary
public String getSimpleName()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this 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

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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

hasNamespace	back to summary
public boolean hasNamespace()

hasSimpleName	back to summary
public boolean hasSimpleName()

hasSimpleName	back to summary
public boolean hasSimpleName(String str) Since 2.3

internSimpleName	back to summary
public PropertyName internSimpleName()

isEmpty	back to summary
public boolean isEmpty() Method that is basically equivalent of: !hasSimpleName() << !hasNamespace(); Since 2.4

isEmpty

back to summary

public boolean isEmpty()

Method that is basically equivalent of:

   !hasSimpleName() << !hasNamespace();

Since: 2.4

merge back to summary

merge	back to summary
public static PropertyName merge(PropertyName name1, PropertyName name2) Method that will combine information from two `PropertyName` instances Parameters name1:PropertyName Name with higher precedence; may be `null` name2:PropertyName Name with lower precedence; may be `null` Returns:PropertyName Merged information; only `null` if both arguments are `null`s. Since 2.17

public static PropertyName merge(PropertyName name1, PropertyName name2)

Method that will combine information from two PropertyName instances

Parameters

name1:PropertyName: Name with higher precedence; may be null
name2:PropertyName: Name with lower precedence; may be null

Returns:PropertyName

Merged information; only null if both arguments are nulls.

Since

2.17

readResolve	back to summary
protected Object readResolve()

simpleAsEncoded	back 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

simpleAsEncoded

back 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

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

withNamespace	back to summary
public PropertyName withNamespace(String ns) Fluent factory method for constructing an instance with different namespace.

withSimpleName	back to summary
public PropertyName withSimpleName(String simpleName) Fluent factory method for constructing an instance with different simple name.

public Class PropertyName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail