Package fr.uga.pddl4j.parser

Class Location

java.lang.Object
fr.uga.pddl4j.parser.Location
All Implemented Interfaces:
Serializable
public class Location extends Object implements Serializable
This abstract class implements the common methods of all object produced by the parser.
See Also:
Serialized Form

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static int
    DEFAULT_BEGIN_COLUMN
    The default begin column value.
    static int
    DEFAULT_BEGIN_LINE
    The default begin line value.
    static int
    DEFAULT_END_COLUMN
    The default begin column value.
    static int
    DEFAULT_END_LINE
    The default end line value.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Location()
    Creates new location with the default line and column value.
    Location​(int beginLine, int beginColumn, int endLine, int endColumn)
    Creates a new locatable object with a specified begin line and column and a specified end line and column.
    Location​(AbstractParsedObject other)
    Creates a parser object from another.
    Location​(Location other)
    Creates a new location from another.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object object)
    Returns if an object location is equal to the location.
    int
    getBeginColumn()
    Returns the begin column of the file where this object appear.
    int
    getBeginLine()
    Returns the begin line of the file where this object appears.
    int
    getEndColumn()
    Returns the end column of the file where this object appears.
    int
    getEndLine()
    Returns the end line of the file where this object appears.
    int
    hashCode()
    Returns the has code value of this location.
    void
    setBegin​(fr.uga.pddl4j.parser.lexer.Token begin)
    Sets the begin line and column of the expression from a specified token.
    void
    setBeginColumn​(int beginColumn)
    Sets the begin column of the file where this object appears.
    void
    setBeginLine​(int beginLine)
    Sets the begin line of the file where this object appears.
    void
    setEnd​(fr.uga.pddl4j.parser.lexer.Token end)
    Sets the end line and column of the expression from a specified token.
    void
    setEndColumn​(int endColumn)
    Sets the end column of the file where this object appears.
    void
    setEndLine​(int endLine)
    Sets the end line of the file where this object appears.
    String
    toString()
    Returns a string representation of this location.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DEFAULT_BEGIN_LINE

      public static final int DEFAULT_BEGIN_LINE
      The default begin line value.
      See Also:
      Constant Field Values

    • DEFAULT_END_LINE

      public static final int DEFAULT_END_LINE
      The default end line value.
      See Also:
      Constant Field Values

    • DEFAULT_BEGIN_COLUMN

      public static final int DEFAULT_BEGIN_COLUMN
      The default begin column value.
      See Also:
      Constant Field Values

    • DEFAULT_END_COLUMN

      public static final int DEFAULT_END_COLUMN
      The default begin column value.
      See Also:
      Constant Field Values

  • Constructor Details

    • Location

      public Location()
      Creates new location with the default line and column value.
      See Also:
      DEFAULT_BEGIN_LINE, DEFAULT_BEGIN_COLUMN, DEFAULT_END_LINE, DEFAULT_END_COLUMN

    • Location

      public Location​(Location other)
      Creates a new location from another.
      Parameters:
      other - the othe location.

    • Location

      public Location​(int beginLine, int beginColumn, int endLine, int endColumn)
      Creates a new locatable object with a specified begin line and column and a specified end line and column.
      Parameters:
      beginLine - the begin line.
      beginColumn - the begin column.
      endLine - the end line.
      endColumn - the end column.

    • Location

      public Location​(AbstractParsedObject other)
      Creates a parser object from another. This constructor creates a deep copy.
      Parameters:
      other - the other object to be copied.

  • Method Details

    • getBeginLine

      public final int getBeginLine()
      Returns the begin line of the file where this object appears. The return value DEFAULT_BEGIN_LIN indicates that the attribute was not initialized.
      Returns:
      the begin line of the file where this object appears or DEFAULT_BEGIN_LINE if it was not initialized.

    • setBeginLine

      public final void setBeginLine​(int beginLine)
      Sets the begin line of the file where this object appears.
      Parameters:
      beginLine - the begin line of the object in the file.

    • getBeginColumn

      public final int getBeginColumn()
      Returns the begin column of the file where this object appear. The return value DEFAULT_BEGIN_COLUMN indicates that the attribute was not initialized.
      Returns:
      the begin column of the file where this object appears or DEFAULT_BEGIN_COLUMN if it was not initialized.

    • setBeginColumn

      public final void setBeginColumn​(int beginColumn)
      Sets the begin column of the file where this object appears.
      Parameters:
      beginColumn - the begin column of the file where this object appears.

    • getEndLine

      public final int getEndLine()
      Returns the end line of the file where this object appears. The return value DEFAULT_EN_LINE indicates that the attribute was not initialized.
      Returns:
      the end line of the file where this object appears or DEFAULT_EN_LINE if it was not initialized.

    • setEndLine

      public final void setEndLine​(int endLine)
      Sets the end line of the file where this object appears.
      Parameters:
      endLine - the end line of the file where this object appeasr.

    • getEndColumn

      public final int getEndColumn()
      Returns the end column of the file where this object appears. The return value DEFAULT_END_COLUMN indicates that the attribute was not initialized.
      Returns:
      the end column of the file where this object appears or DEFAULT_END_COLUMN if it was not initialized.

    • setEndColumn

      public final void setEndColumn​(int endColumn)
      Sets the end column of the file where this object appears.
      Parameters:
      endColumn - the end column of the file where this object appears.

    • setBegin

      public final void setBegin​(fr.uga.pddl4j.parser.lexer.Token begin)
      Sets the begin line and column of the expression from a specified token.
      Parameters:
      begin - the first token of the expression.

    • setEnd

      public final void setEnd​(fr.uga.pddl4j.parser.lexer.Token end)
      Sets the end line and column of the expression from a specified token.
      Parameters:
      end - the last token of the expression.

    • equals

      public boolean equals​(Object object)
      Returns if an object location is equal to the location.
      Overrides:
      equals in class Object
      Returns:
      true if the object is equal to this location, i.e., if it is an object of the class Location and it has the same begin and end line and begin and end column; otherwise false.

    • hashCode

      public int hashCode()
      Returns the has code value of this location.
      Overrides:
      hashCode in class Object
      Returns:
      the has code value of this location.
      See Also:
      Object.hashCode()

    • toString

      public String toString()
      Returns a string representation of this location.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this location.