org.jamplate.model

Class Reference

java.lang.Object

org.jamplate.model.Reference

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Reference>

public final class Reference
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<Reference>

A source reference is a component that points to a document or a fragment of it.

Since:

0.2.0 ~2020.12.25

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Reference() Construct a new reference with the position 0 and 0 length.
Reference(int position) Construct a new reference wit the given position and 0 length.
Reference(int position, int length) Construct a new reference that starts at the given position and has the given length.

Method Summary

Modifier and Type	Method and Description
int	compareTo(@NotNull Reference reference) A reference is greater that another reference when it has a position less that the other.
boolean	equals(@Nullable java.lang.Object object) A reference is equals another object, if that object is a reference and has the same position() and length() of this source.
int	hashCode() The hash code of a reference is calculated as follows.
int	length() The length of this reference.
int	position() Return where this reference starts at its document.
@NotNull Reference	subReference(int position) Slice this reference from the given position to the end of this reference.
@NotNull Reference	subReference(int position, int length) Slice this reference from the given position and limit it with the given length.
@NotNull java.lang.String	toString() Returns a string representation of this reference.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reference

public Reference()

Construct a new reference with the position 0 and 0 length.

Since:

0.2.0 ~2021.02.19

Reference

public Reference(int position)

Construct a new reference wit the given position and 0 length.

Parameters:

position - the position of the constructed reference.

Throws:

java.lang.IllegalArgumentException - if the given position is negative.

Since:

0.2.0 ~2021.02.19

Reference

public Reference(int position,
                 int length)

Construct a new reference that starts at the given position and has the given length.

Parameters:

position - the position where the constructed reference will start.

length - the length of the constructed reference.

Throws:

java.lang.IllegalArgumentException - if the given position or length is negative.

Since:

0.2.0 ~2021.02.17

Method Detail

compareTo

@Contract(pure=true)
public int compareTo(@NotNull
                                           @NotNull Reference reference)

A reference is greater that another reference when it has a position less that the other. If both references are at the same position then the shortest reference is the greatest.

Specified by:

compareTo in interface java.lang.Comparable<Reference>

Parameters:

reference - the reference to be compare to this reference.

Returns:

the results of comparing this reference to the given reference. -1 if this reference is less than the given reference. 1 if this reference is greater. 0 if they are equal.

Throws:

java.lang.NullPointerException - if the given reference is null.

Since:

0.2.0 ~2021.02.17

equals

@Contract(value="null->false",
          pure=true)
public boolean equals(@Nullable
                                                                            @Nullable java.lang.Object object)

A reference is equals another object, if that object is a reference and has the same position() and length() of this source.

     equals = object instanceof Reference &&
                        object.position == this.position &&
                        object.length == this.length
 

Overrides:

equals in class java.lang.Object

Parameters:

object - the object to be matched.

Returns:

if the given object is a reference and equals this reference.

Since:

0.2.0 ~2021.01.07

hashCode

@Contract(pure=true)
public int hashCode()

The hash code of a reference is calculated as follows.

     hashCode = <Position> + <Length>
 

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code of this reference.

Since:

0.2.0 ~2021.01.07

toString

@NotNull
 @Contract(pure=true)
public @NotNull java.lang.String toString()

Returns a string representation of this reference.

     toString = (<Position>, <Length>)
 

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this reference.

Since:

0.2.0 ~2021.01.06

length

@Contract(pure=true)
public int length()

The length of this reference. Must always return the same value. Must always be the same as the length of the content of this source.

Returns:

the length of the content of this reference.

Since:

0.2.0 ~2021.01.10

position

@Contract(pure=true)
public int position()

Return where this reference starts at its document.

Returns:

the position of this reference.

Since:

0.2.0 ~2021.01.04

subReference

@NotNull
 @Contract(value="_->new",
          pure=true)
public @NotNull Reference subReference(int position)

Slice this reference from the given position to the end of this reference.

Parameters:

position - the position where the new slice reference will have relative to this reference.

Returns:

a sub reference of this reference that starts from the given position relative to this reference.

Throws:

java.lang.IllegalArgumentException - if the given position is negative.

java.lang.IndexOutOfBoundsException - if position > this.length().

java.lang.IllegalStateException - if this reference is a deserialized reference.

Since:

0.2.0 ~2021.01.06

subReference

@NotNull
 @Contract(value="_,_->new",
          pure=true)
public @NotNull Reference subReference(int position,
                                                                                                     int length)

Slice this reference from the given position and limit it with the given length.

Parameters:

position - the position where the new slice reference will have relative to this reference.

length - the length of the new slice reference.

Returns:

a slice of this reference that starts from the given position relative to this reference and have the given length.

Throws:

java.lang.IllegalArgumentException - if the given position or length is negative.

java.lang.IndexOutOfBoundsException - if position + length > this.length().

java.lang.IllegalStateException - if this reference is a deserialized reference.

Since:

0.2.0 ~2021.01.06