Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.FoldingRange

Modifier and Type	Field and Description
private String	collapsedText The text that the client should show when the specified range is collapsed.
private Integer	endCharacter The zero-based character offset before the folded range ends.
private int	endLine The zero-based line number where the folded range ends.
private String	kind Describes the kind of the folding range such as `FoldingRangeKind#Comment` or `FoldingRangeKind#Region`.
private Integer	startCharacter The zero-based character offset from where the folded range starts.
private int	startLine The zero-based line number from where the folded range starts.

Access	Constructor and Description
public	FoldingRange()
public	FoldingRange(final int startLine, final int endLine)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getCollapsedText() The text that the client should show when the specified range is collapsed.
public Integer	getEndCharacter() The zero-based character offset before the folded range ends.
public int	getEndLine() The zero-based line number where the folded range ends.
public String	getKind() Describes the kind of the folding range such as `FoldingRangeKind#Comment` or `FoldingRangeKind#Region`.
public Integer	getStartCharacter() The zero-based character offset from where the folded range starts.
public int	getStartLine() The zero-based line number from where the folded range starts.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setCollapsedText(final String collapsedText) The text that the client should show when the specified range is collapsed.
public void	setEndCharacter(final Integer endCharacter) The zero-based character offset before the folded range ends.
public void	setEndLine(final int endLine) The zero-based line number where the folded range ends.
public void	setKind(final String kind) Describes the kind of the folding range such as `FoldingRangeKind#Comment` or `FoldingRangeKind#Region`.
public void	setStartCharacter(final Integer startCharacter) The zero-based character offset from where the folded range starts.
public void	setStartLine(final int startLine) The zero-based line number from where the folded range starts.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

collapsedText	back to summary
private String collapsedText The text that the client should show when the specified range is collapsed. If not defined or not supported by the client, a default will be chosen by the client. Since 3.17.0

endCharacter	back to summary
private Integer endCharacter The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.

endLine	back to summary
private int endLine The zero-based line number where the folded range ends.

kind	back to summary
private String kind Describes the kind of the folding range such as `FoldingRangeKind#Comment` or `FoldingRangeKind#Region`. The kind is used to categorize folding ranges and used by commands like 'Fold all comments'. See `FoldingRangeKind` for an enumeration of standardized kinds.

startCharacter	back to summary
private Integer startCharacter The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.

startLine	back to summary
private int startLine The zero-based line number from where the folded range starts.

FoldingRange	back to summary
public FoldingRange()

FoldingRange	back to summary
public FoldingRange(final int startLine, final int endLine)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final 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. Annotations @Override

public boolean equals(final 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.

Annotations

@Override

getCollapsedText	back to summary
public String getCollapsedText() The text that the client should show when the specified range is collapsed. If not defined or not supported by the client, a default will be chosen by the client. Since 3.17.0

getCollapsedText

back to summary

public String getCollapsedText()

The text that the client should show when the specified range is collapsed. If not defined or not supported by the client, a default will be chosen by the client.

Since 3.17.0

getEndCharacter	back to summary
public Integer getEndCharacter() The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.

getEndLine	back to summary
public int getEndLine() The zero-based line number where the folded range ends.

getKind	back to summary
public String getKind() Describes the kind of the folding range such as `FoldingRangeKind#Comment` or `FoldingRangeKind#Region`. The kind is used to categorize folding ranges and used by commands like 'Fold all comments'. See `FoldingRangeKind` for an enumeration of standardized kinds.

getStartCharacter	back to summary
public Integer getStartCharacter() The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.

getStartLine	back to summary
public int getStartLine() The zero-based line number from where the folded range starts.

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. 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.

Annotations

@Override

setCollapsedText	back to summary
public void setCollapsedText(final String collapsedText) The text that the client should show when the specified range is collapsed. If not defined or not supported by the client, a default will be chosen by the client. Since 3.17.0

setCollapsedText

back to summary

public void setCollapsedText(final String collapsedText)

The text that the client should show when the specified range is collapsed. If not defined or not supported by the client, a default will be chosen by the client.

Since 3.17.0

setEndCharacter	back to summary
public void setEndCharacter(final Integer endCharacter) The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.

setEndLine	back to summary
public void setEndLine(final int endLine) The zero-based line number where the folded range ends.

setKind	back to summary
public void setKind(final String kind) Describes the kind of the folding range such as `FoldingRangeKind#Comment` or `FoldingRangeKind#Region`. The kind is used to categorize folding ranges and used by commands like 'Fold all comments'. See `FoldingRangeKind` for an enumeration of standardized kinds.

setStartCharacter	back to summary
public void setStartCharacter(final Integer startCharacter) The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.

setStartLine	back to summary
public void setStartLine(final int startLine) The zero-based line number from where the folded range starts.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class FoldingRange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail