Package org.apache.cayenne.exp.path

# Class CayennePathSegment

java.lang.Object
org.apache.cayenne.exp.path.CayennePathSegment

All Implemented Interfaces:
  `Serializable`, `CharSequence`

public class CayennePathSegment extends Object implements CharSequence, Serializable
Value object representing segment of a `CayennePath`

This class is a thin wrapper for a String value.

Since:
  5.0
See Also:
  - `CayennePath.segmentOf(String, boolean)`
  - `CayennePath.segmentOf(String)`
  - Serialized Form

- ## Method Summary

  Modifier and Type
  Method
  Description
  `char`
  `charAt(int index)`
  `boolean`
  `equals(Object o)`
  `int`
  `hashCode()`
  `boolean`
  `isOuterJoin()`
  `int`
  `length()`
  `CayennePathSegment`
  `outer()`
  `CharSequence`
  `subSequence(int start, int end)`
  `String`
  `toString()`
  `String`
  `value()`

  ### Methods inherited from class java.lang.Object

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

  ### Methods inherited from interface java.lang.CharSequence

  `chars, codePoints, isEmpty`

- ## Method Details

  - ### value

    public String value()

  - ### isOuterJoin

    public boolean isOuterJoin()

  - ### outer

    public CayennePathSegment outer()

  - ### equals

    public boolean equals(Object o)
    Overrides:
      `equals` in class `Object`

  - ### hashCode

    public int hashCode()
    Overrides:
      `hashCode` in class `Object`

  - ### toString

    public String toString()
    Specified by:
      `toString` in interface `CharSequence`
    Overrides:
      `toString` in class `Object`

  - ### length

    public int length()
    Specified by:
      `length` in interface `CharSequence`

  - ### charAt

    public char charAt(int index)
    Specified by:
      `charAt` in interface `CharSequence`

  - ### subSequence

    public CharSequence subSequence(int start, int end)
    Specified by:
      `subSequence` in interface `CharSequence`