Top Fields Constructors Methods
org.hibernate.boot.model.source.spi

public abstract Class AbstractAttributeKey

extends Object
Class Inheritance
Known Direct Subclasses
org.hibernate.boot.model.source.spi.AttributePath, org.hibernate.boot.model.source.spi.AttributeRole
Imports
java.util.regex.Matcher, .Pattern, org.hibernate.internal.util.StringHelper

Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private static final String
private final int
private static final String
private static final Pattern
private final String
private final AbstractAttributeKey
private final String

Constructor Summary

AccessConstructor and Description
protected
AbstractAttributeKey()

Constructor for the base AttributePath

protected
AbstractAttributeKey(String base)

Constructor for the base AttributeRole

protected

Method Summary

Modifier and TypeMethod and Description
public abstract AbstractAttributeKey

Returns:

The new AbstractAttributeKey
append
(String
The part to append
property
)

Creates a new AbstractAttributeKey by appending the passed part.

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.
protected abstract char
public int

Returns:

The number of parts.
getDepth
()

How many "parts" are there to this path/role?

public String

Returns:

The full path as a String
getFullPath
()

Access to the full path as a String

public AbstractAttributeKey

Returns:

the parent part
getParent
()

Access to the parent part

public String

Returns:

the end path part
getProperty
()

Access to the end path part.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean

Returns:

true if the current property is a collection element marker (COLLECTION_ELEMENT
isCollectionElement
()

Does this part represent a collection-element reference?

public boolean

Returns:

true if this part or any parent part is a collection element marker (COLLECTION_ELEMENT.
isPartOfCollectionElement
()

Does any part represent a collection-element reference?

public boolean

Returns:

true if this part is a root.
isRoot
()

Does this part represent a root.

public String
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

COLLECTION_ELEMENTback to summary
private static final String COLLECTION_ELEMENT
depthback to summary
private final int depth
DOT_COLLECTION_ELEMENTback to summary
private static final String DOT_COLLECTION_ELEMENT
DOT_COLLECTION_ELEMENT_PATTERNback to summary
private static final Pattern DOT_COLLECTION_ELEMENT_PATTERN
fullPathback to summary
private final String fullPath
parentback to summary
private final AbstractAttributeKey parent
propertyback to summary
private final String property

Constructor Detail

AbstractAttributeKeyback to summary
protected AbstractAttributeKey()

Constructor for the base AttributePath

AbstractAttributeKeyback to summary
protected AbstractAttributeKey(String base)

Constructor for the base AttributeRole

AbstractAttributeKeyback to summary
protected AbstractAttributeKey(AbstractAttributeKey parent, String property)

Method Detail

appendback to summary
public abstract AbstractAttributeKey append(String property)

Creates a new AbstractAttributeKey by appending the passed part.

Parameters
property:String

The part to append

Returns:AbstractAttributeKey

The new AbstractAttributeKey

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
getDelimiterback to summary
protected abstract char getDelimiter()
getDepthback to summary
public int getDepth()

How many "parts" are there to this path/role?

Returns:int

The number of parts.

getFullPathback to summary
public String getFullPath()

Access to the full path as a String

Returns:String

The full path as a String

getParentback to summary
public AbstractAttributeKey getParent()

Access to the parent part

Returns:AbstractAttributeKey

the parent part

getPropertyback to summary
public String getProperty()

Access to the end path part.

Returns:String

the end path part

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
isCollectionElementback to summary
public boolean isCollectionElement()

Does this part represent a collection-element reference?

Returns:boolean

true if the current property is a collection element marker (COLLECTION_ELEMENT

isPartOfCollectionElementback to summary
public boolean isPartOfCollectionElement()

Does any part represent a collection-element reference?

Returns:boolean

true if this part or any parent part is a collection element marker (COLLECTION_ELEMENT.

isRootback to summary
public boolean isRoot()

Does this part represent a root.

Returns:boolean

true if this part is a root.

stripCollectionElementMarkerback to summary
public String stripCollectionElementMarker()
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