Enum Direction

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Direction>

    public enum Direction
    extends java.lang.Enum<Direction>
    Defines relationship directions used when getting relationships from a node. A relationship has a direction from a node's point of view. If a node is the start node of a relationship it will be an OUTGOING relationship from that node's point of view. If a node is the end node of a relationship it will be an INCOMING relationship from that node's point of view. The BOTH direction is used when direction is of no importance, such as "give me all" relationships that are either OUTGOING or INCOMING.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BOTH
      Defines both incoming and outgoing relationships.
      INCOMING
      Defines incoming relationships.
      OUTGOING
      Defines outgoing relationships.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Direction valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Direction[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • BOTH

        public static final Direction BOTH
        Defines both incoming and outgoing relationships.
      • INCOMING

        public static final Direction INCOMING
        Defines incoming relationships.
      • OUTGOING

        public static final Direction OUTGOING
        Defines outgoing relationships.
    • Method Detail

      • values

        public static Direction[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Direction c : Direction.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Direction valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null