flexmark-all 0.64.8 · com.vladsch.flexmark.util.sequence.BasedOptionsSequence

Modifier and Type	Field and Description
private final @NotNull CharSequence	chars
private final int	optionFlags
private final @Nullable DataHolder	options

Access	Constructor and Description
private	BasedOptionsSequence(@NotNull CharSequence chars, int optionFlags, @Nullable DataHolder options)

Method Summary

Modifier and Type	Method and Description
public boolean	allOptions(int option flags options) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.allOptions. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions
public boolean	anyOptions(int option flags options) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.anyOptions. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions
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 IntStream	chars() Overrides default java.lang.CharSequence.chars. Returns a stream of `int` zero-extending the `char` values from this sequence.
public IntStream	codePoints() Overrides default java.lang.CharSequence.codePoints. Returns a stream of code point values from this sequence.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public <T> T	getOption(DataKeyBase<T> in options dataKey) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOption. Options holder, default has none, only available on BasedSequenceWithOptions
public int	getOptionFlags() Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptionFlags. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions
public @Nullable DataHolder	getOptions() Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptions. Options holder, default has none, only available on BasedSequenceWithOptions
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 BasedOptionsSequence	of(@NotNull CharSequence chars, BitFieldSet<BasedOptionsHolder.Options> optionFlags)
public static BasedOptionsSequence	of(@NotNull CharSequence chars, int optionFlags)
public static BasedOptionsSequence	of(@NotNull CharSequence chars, BitFieldSet<BasedOptionsHolder.Options> optionFlags, @Nullable DataHolder options)
public static BasedOptionsSequence	of(@NotNull CharSequence chars, int optionFlags, @Nullable DataHolder options)
public CharSequence	subSequence(int the start index, inclusive start, int the end index, exclusive end) Implements java.lang.CharSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence.
public 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:: clone finalize getClass notify notifyAll wait wait wait

chars	back to summary
private final @NotNull CharSequence chars Annotations @NotNull

optionFlags	back to summary
private final int optionFlags

options	back to summary
private final @Nullable DataHolder options Annotations @Nullable

BasedOptionsSequence	back to summary
private BasedOptionsSequence(@NotNull CharSequence chars, int optionFlags, @Nullable DataHolder options)

Method Detail

allOptions	back to summary
public boolean allOptions(int options) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.allOptions. Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.allOptions. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions Parameters options:int option flags Returns:boolean true if all option flags passed are set for this sequence Annotations @Override

allOptions

back to summary

public boolean allOptions(int options)

Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.allOptions.

Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.allOptions.

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

Parameters

options:int: option flags

Returns:boolean

true if all option flags passed are set for this sequence

Annotations

@Override

anyOptions	back to summary
public boolean anyOptions(int options) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.anyOptions. Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.anyOptions. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions Parameters options:int option flags Returns:boolean true if any option flags passed are set for this sequence Annotations @Override

anyOptions

back to summary

public boolean anyOptions(int options)

Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.anyOptions.

Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.anyOptions.

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

Parameters

options:int: option flags

Returns:boolean

true if any option flags passed are set for this sequence

Annotations

@Override

charAt back to summary

charAt	back 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

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

chars back to summary

chars	back to summary
public IntStream chars() Overrides default java.lang.CharSequence.chars. Doc from java.lang.CharSequence.chars. Returns a stream of `int` zero-extending the `char` values from this sequence. Any char which maps to a surrogate code point is passed through uninterpreted. The stream binds to this sequence when the terminal stream operation commences (specifically, for mutable sequences the spliterator for the stream is late-binding). If the sequence is modified during that operation then the result is undefined. Returns:IntStream an IntStream of char values from this sequence Annotations @Override

public IntStream chars()

Overrides default java.lang.CharSequence.chars.

Doc from java.lang.CharSequence.chars.

Returns a stream of int zero-extending the char values from this sequence. Any char which maps to a surrogate code point is passed through uninterpreted.

The stream binds to this sequence when the terminal stream operation commences (specifically, for mutable sequences the spliterator for the stream is late-binding). If the sequence is modified during that operation then the result is undefined.

Returns:IntStream

an IntStream of char values from this sequence

Annotations

@Override

codePoints back to summary

codePoints	back to summary
public IntStream codePoints() Overrides default java.lang.CharSequence.codePoints. Doc from java.lang.CharSequence.codePoints. Returns a stream of code point values from this sequence. Any surrogate pairs encountered in the sequence are combined as if by Character.toCodePoint and the result is passed to the stream. Any other code units, including ordinary BMP characters, unpaired surrogates, and undefined code units, are zero-extended to `int` values which are then passed to the stream. The stream binds to this sequence when the terminal stream operation commences (specifically, for mutable sequences the spliterator for the stream is late-binding). If the sequence is modified during that operation then the result is undefined. Returns:IntStream an IntStream of Unicode code points from this sequence Annotations @Override

public IntStream codePoints()

Overrides default java.lang.CharSequence.codePoints.

Doc from java.lang.CharSequence.codePoints.

Returns a stream of code point values from this sequence. Any surrogate pairs encountered in the sequence are combined as if by Character.toCodePoint and the result is passed to the stream. Any other code units, including ordinary BMP characters, unpaired surrogates, and undefined code units, are zero-extended to int values which are then passed to the stream.

Returns:IntStream

an IntStream of Unicode code points from this sequence

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) 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 o: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 @SuppressWarnings:EqualsWhichDoesntCheckParameterClass

public boolean equals(Object o)

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

o: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
@SuppressWarnings:EqualsWhichDoesntCheckParameterClass

getOption	back to summary
public <T> T getOption(DataKeyBase<T> dataKey) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOption. Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOption. Options holder, default has none, only available on BasedSequenceWithOptions Parameters <T> type of value held by key dataKey:DataKeyBase<T> in options Returns:T true if data key is available Annotations @Override

getOptionFlags	back to summary
public int getOptionFlags() Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptionFlags. Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptionFlags. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions Returns:int option flags for this sequence Annotations @Override

getOptionFlags

back to summary

public int getOptionFlags()

Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptionFlags.

Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptionFlags.

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

Returns:int

option flags for this sequence

Annotations

@Override

getOptions	back to summary
public @Nullable DataHolder getOptions() Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptions. Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptions. Options holder, default has none, only available on BasedSequenceWithOptions Returns:@Nullable DataHolder data holder with options or null if none for this sequence Annotations @Nullable @Override

getOptions

back to summary

public @Nullable DataHolder getOptions()

Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptions.

Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptions.

Options holder, default has none, only available on BasedSequenceWithOptions

Returns:@Nullable DataHolder

data holder with options or null if none for this sequence

Annotations

@Nullable
@Override

hashCode back to summary

hashCode	back 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

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

length back to summary

length	back 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 `char`s in the sequence. Returns:int the number of `char`s in this sequence Annotations @Override

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

of	back to summary
public static BasedOptionsSequence of(@NotNull CharSequence chars, BitFieldSet<BasedOptionsHolder.Options> optionFlags)

of	back to summary
public static BasedOptionsSequence of(@NotNull CharSequence chars, int optionFlags)

of	back to summary
public static BasedOptionsSequence of(@NotNull CharSequence chars, BitFieldSet<BasedOptionsHolder.Options> optionFlags, @Nullable DataHolder options)

of	back to summary
public static BasedOptionsSequence of(@NotNull CharSequence chars, int optionFlags, @Nullable DataHolder options)

subSequence back to summary

subSequence	back to summary
public CharSequence subSequence(int start, int end) 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 `char`s) of the returned sequence is `end - start`, so if `start == end` then an empty sequence is returned. Parameters start:int the start index, inclusive end:int the end index, exclusive Returns:CharSequence the specified subsequence Annotations @Override

public CharSequence subSequence(int start, int end)

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

start:int: the start index, inclusive
end:int: the end index, exclusive

Returns:CharSequence

the specified subsequence

Annotations

@Override

toString	back to summary
public 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:String a string consisting of exactly this sequence of characters Annotations @Override

toString

back to summary

public 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:String

a string consisting of exactly this sequence of characters

Annotations

@Override

public final Class BasedOptionsSequence

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail