com.asakusafw.utils.java.internal.parser.javadoc.ir

Class IrLocation

java.lang.Object

com.asakusafw.utils.java.internal.parser.javadoc.ir.IrLocation

All Implemented Interfaces:

Serializable

public class IrLocation
extends Object
implements Serializable

Represents locations on IrDocComment.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IrLocation(int startPosition, int length) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getLength() Returns the character length.
int	getStartPosition() Returns the starting position.
int	hashCode()
static IrLocation	move(IrLocation base, int offset) Returns a new location object which is moved the base location as the specified offset.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IrLocation

public IrLocation(int startPosition,
                  int length)

Creates a new instance.

Parameters:

startPosition - the starting position (0-origin)

length - the character length

Throws:

IllegalArgumentException - if some parameters are negative value

Method Detail

getStartPosition

public int getStartPosition()

Returns the starting position.

Returns:

the starting position

getLength

public int getLength()

Returns the character length.

Returns:

the character length

move

public static IrLocation move(IrLocation base,
                              int offset)

Returns a new location object which is moved the base location as the specified offset.

Parameters:

base - the base location (nullable)

offset - the moving offset

Returns:

the moved location, or null if the base location is also null

Throws:

IllegalArgumentException - if the moved location starts with negative position

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object