Top Description Fields Constructors Methods
com.vladsch.flexmark.util.sequence

public Class RepeatedSequence

extends Object
implements CharSequence
Class Inheritance
All Implemented Interfaces
java.lang.CharSequence
Imports
org.jetbrains.annotations.NotNull

CharSequence that repeats in a wraparound the given sequence.

Partial repeat occurs when start % length() >0 and/or end % length() >0

The hashCode is purposefully matched to the string equivalent or this.toString().hashCode()

Field Summary

Modifier and TypeField and Description
private final CharSequence
private final int
private int
public static RepeatedSequence
private final int

Constructor Summary

AccessConstructor and Description
private
RepeatedSequence(CharSequence chars, int startIndex, int endIndex)

Method Summary

Modifier and TypeMethod and Description
public char
charAt(int
the index of the char value to be returned
index
)

Implements java.lang.CharSequence.charAt.

Returns the char value at the specified index.

public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public int
length()

Implements java.lang.CharSequence.length.

Returns the length of this character sequence.

public static @NotNull CharSequence
of(char c, int count)
Deprecated

public static @NotNull CharSequence
of(@NotNull CharSequence chars, int count)
Deprecated

public static @NotNull CharSequence
of(@NotNull CharSequence chars, int startIndex, int endIndex)
Deprecated

public static @NotNull CharSequence
ofSpaces(int count)

public RepeatedSequence
repeat(int count)

public static @NotNull CharSequence
repeatOf(char c, int count)

public static @NotNull CharSequence
repeatOf(@NotNull CharSequence chars, int count)

public static @NotNull CharSequence
repeatOf(@NotNull CharSequence chars, int startIndex, int endIndex)

public CharSequence
subSequence(int
the start index, inclusive
startIndex
,
int
the end index, exclusive
endIndex
)

Implements java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence.

public @NotNull String
toString()

Overrides java.lang.Object.toString.

Implements java.lang.CharSequence.toString.

Returns a string containing the characters in this sequence in the same order as this sequence.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

charsback to summary
private final CharSequence chars
endIndexback to summary
private final int endIndex
hashCodeback to summary
private int hashCode
NULLback to summary
public static RepeatedSequence NULL
startIndexback to summary
private final int startIndex

Constructor Detail

RepeatedSequenceback to summary
private RepeatedSequence(CharSequence chars, int startIndex, int endIndex)

Method Detail

charAtback to summary
public char charAt(int index)

Implements java.lang.CharSequence.charAt.

Doc from java.lang.CharSequence.charAt.

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters
index:int

the index of the char value to be returned

Returns:char

the specified char value

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
lengthback to summary
public int length()

Implements java.lang.CharSequence.length.

Doc from java.lang.CharSequence.length.

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Returns:int

the number of chars in this sequence

Annotations
@Override
ofback to summary
public static @NotNull CharSequence of(char c, int count)

Deprecated

Annotations
@NotNull
@Deprecated
ofback to summary
public static @NotNull CharSequence of(@NotNull CharSequence chars, int count)

Deprecated

Annotations
@NotNull
@Deprecated
ofback to summary
public static @NotNull CharSequence of(@NotNull CharSequence chars, int startIndex, int endIndex)

Deprecated

Annotations
@NotNull
@Deprecated
ofSpacesback to summary
public static @NotNull CharSequence ofSpaces(int count)
Annotations
@NotNull
repeatback to summary
public RepeatedSequence repeat(int count)
repeatOfback to summary
public static @NotNull CharSequence repeatOf(char c, int count)
Annotations
@NotNull
repeatOfback to summary
public static @NotNull CharSequence repeatOf(@NotNull CharSequence chars, int count)
Annotations
@NotNull
repeatOfback to summary
public static @NotNull CharSequence repeatOf(@NotNull CharSequence chars, int startIndex, int endIndex)
Annotations
@NotNull
subSequenceback to summary
public CharSequence subSequence(int startIndex, int endIndex)

Implements java.lang.CharSequence.subSequence.

Doc from java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters
startIndex:int

the start index, inclusive

endIndex:int

the end index, exclusive

Returns:CharSequence

the specified subsequence

Annotations
@Override
toStringback to summary
public @NotNull String toString()

Overrides java.lang.Object.toString.

Implements java.lang.CharSequence.toString.

Doc from java.lang.CharSequence.toString.

Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.

Returns:@NotNull String

a string consisting of exactly this sequence of characters

Annotations
@NotNull
@Override