Path.Element (Apache Jackrabbit 2.20.16 API)

All Superinterfaces:

Serializable

Enclosing interface:

Path
```
public static interface Path.Element
extends Serializable
```
Object representation of a single JCR path element. An Element object contains the Name and optional index of a single JCR path element.
Once created, a Element object must be immutable.
The String presentation of an Element must be in the format "{namespaceURI}localPart" or "{namespaceURI}localPart[index]" case of an index greater than Path.INDEX_DEFAULT.
Note, that the implementation must implement the equals method such, that two Element objects having equals Names and the same normalized index must be equal.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`denotesCurrent()` Returns `true` if this element denotes the current ('.') element, otherwise returns `false`.
`boolean`	`denotesIdentifier()` Returns `true` if this element represents an identifier element.
`boolean`	`denotesName()` Returns `true` if this element represents a regular name (i.e.
`boolean`	`denotesParent()` Returns `true` if this element denotes the parent ('..') element, otherwise returns `false`.
`boolean`	`denotesRoot()` Returns `true` if this element denotes the root element, otherwise returns `false`.
`String`	`getIdentifier()` Returns the identifier of an identifier element, or `null` for other kinds of elements.
`int`	`getIndex()` Returns the index of the element as it has been assigned upon creation.
`Name`	`getName()` Returns the name of this path element.
`int`	`getNormalizedIndex()` Returns the normalized index of this path element, i.e.
`String`	`getString()` Return the String presentation of a `Path.Element`.

- Method Detail
  - getName
```
Name getName()
```
    Returns the name of this path element.
    
    Returns:
    
    The name of this path element.
  - getIndex
```
int getIndex()
```
    Returns the index of the element as it has been assigned upon creation.
    
    Returns:
    
    index of the element as it has been assigned upon creation.
  - getNormalizedIndex
```
int getNormalizedIndex()
```
    Returns the normalized index of this path element, i.e. the index is always equals or greater that Path.INDEX_DEFAULT.
    
    Returns:
    
    the normalized index.
  - getIdentifier
```
String getIdentifier()
```
    Returns the identifier of an identifier element, or null for other kinds of elements.
    
    Returns:
    
    identifier, or null
  - denotesRoot
```
boolean denotesRoot()
```
    Returns true if this element denotes the root element, otherwise returns false.
    
    Returns:
    
    true if this element denotes the root element; otherwise false
  - denotesParent
```
boolean denotesParent()
```
    Returns true if this element denotes the parent ('..') element, otherwise returns false.
    
    Returns:
    
    true if this element denotes the parent element; otherwise false
  - denotesCurrent
```
boolean denotesCurrent()
```
    Returns true if this element denotes the current ('.') element, otherwise returns false.
    
    Returns:
    
    true if this element denotes the current element; otherwise false
  - denotesName
```
boolean denotesName()
```
    Returns true if this element represents a regular name (i.e. neither root, '.' nor '..'), otherwise returns false.
    
    Returns:
    
    true if this element represents a regular name; otherwise false
  - denotesIdentifier
```
boolean denotesIdentifier()
```
    Returns true if this element represents an identifier element.
    
    Returns:
    
    true if this element represents an identifier element.
    
    Since:
    
    JCR 2.0
  - getString
```
String getString()
```
    Return the String presentation of a Path.Element. It must be in the format "{namespaceURI}localPart" or "{namespaceURI}localPart[index]" in case of an index greater than Path.INDEX_DEFAULT.
    
    Returns:
    
    String representation of a Path.Element.

Interface Path.Element

Method Summary

Method Detail

getName

getIndex

getNormalizedIndex

getIdentifier

denotesRoot

denotesParent

denotesCurrent

denotesName

denotesIdentifier

getString