Top Description Methods
org.hibernate.spi

public Interface DotIdentifierSequence

Known Direct Subinterfaces
org.hibernate.query.hql.internal.FullyQualifiedReflectivePathSource
Known Direct Implementers
org.hibernate.spi.NavigablePath, org.hibernate.loader.PropertyPath, org.hibernate.metamodel.mapping.SelectablePath, org.hibernate.metamodel.model.domain.NavigableRole
Imports
java.util.ArrayList, .List, org.hibernate.internal.util.NullnessUtil, org.checkerframework.checker.nullness.qual.Nullable
A compound name.

Hibernate often deals with compound names/paths. This interface defines a standard way of interacting with them.

Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public DotIdentifierSequence
append(String subPathName)

Append a new part to the end of this sequence, returning the new representation.

public String
getFullPath()

The full sequence text.

public String
getLocalName()

The name of this leaf sequence part.

public @Nullable DotIdentifierSequence
getParent()

The parent sequence part.

public default DotIdentifierSequence[]
getParts()

public default boolean
isRoot()

Is this sequence node the root of the sequence?

private void
parts(List<DotIdentifierSequence> list)

Method Detail

appendback to summary
public DotIdentifierSequence append(String subPathName)

Append a new part to the end of this sequence, returning the new representation.

Given the sequence a.b.c, appending d results in the new sequence a.b.c.d.

getFullPathback to summary
public String getFullPath()

The full sequence text.

Given the sequence a.b.c, returns the string "a.b.c".

Implementation Note

This method may dynamically build the returned string and should be avoided for critical paths (comparisons,for example).

getLocalNameback to summary
public String getLocalName()

The name of this leaf sequence part.

Given the sequence a.b.c, returns the string "c".

getParentback to summary
public @Nullable DotIdentifierSequence getParent()

The parent sequence part.

Given the sequence a.b.c, returns the sequence a.b.

getPartsback to summary
public default DotIdentifierSequence[] getParts()
isRootback to summary
public default boolean isRoot()

Is this sequence node the root of the sequence?

Same as checking the nullness of getParent().

partsback to summary
private void parts(List<DotIdentifierSequence> list)