Interface Named

All Superinterfaces:
IdentifiableElement
All Known Subinterfaces:
Node, PropertyContainer, Relationship
All Known Implementing Classes:
NamedPath, NodeBase, RelationshipBase

@API(status=STABLE, since="1.0") public non-sealed interface Named extends IdentifiableElement
A named thing exposes getSymbolicName(), making the thing identifiable.
Since:
1.0
Author:
Michael J. Simons
  • Method Details

    • getSymbolicName

      Optional<SymbolicName> getSymbolicName()
      Returns an optional symbolic name.
      Returns:
      an optional symbolic name
    • getRequiredSymbolicName

      default SymbolicName getRequiredSymbolicName()
      Return a symbolic name.
      Returns:
      a symbolic name
      Throws:
      IllegalStateException - if this has not been named yet.
    • asExpression

      default Expression asExpression()
      Description copied from interface: IdentifiableElement
      Transform this element into an expression.
      Specified by:
      asExpression in interface IdentifiableElement
      Returns:
      this element as an expression. Will return the same instance if it is already an expression.