Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class FoldingRangeCapabilities

extends DynamicRegistrationCapabilities
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
org.eclipse.lsp4j.jsonrpc.util.ToStringBuilder

Capabilities specific to `textDocument/foldingRange` requests.

Since 3.10.0

Field Summary

Modifier and TypeField and Description
private FoldingRangeSupportCapabilities
foldingRange

Specific options for the folding range.

private FoldingRangeKindSupportCapabilities
foldingRangeKind

Specific options for the folding range kind.

private Boolean
lineFoldingOnly

If set, the client signals that it only supports folding complete lines.

private Integer
rangeLimit

The maximum number of folding ranges that the client prefers to receive per document.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object obj)

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.equals.

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

public FoldingRangeSupportCapabilities
getFoldingRange()

Specific options for the folding range.

public FoldingRangeKindSupportCapabilities
getFoldingRangeKind()

Specific options for the folding range kind.

public Boolean
getLineFoldingOnly()

If set, the client signals that it only supports folding complete lines.

public Integer
getRangeLimit()

The maximum number of folding ranges that the client prefers to receive per document.

public int
hashCode()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.hashCode.

Returns a hash code value for this object.

public void
setFoldingRange(final FoldingRangeSupportCapabilities foldingRange)

Specific options for the folding range.

public void
setFoldingRangeKind(final FoldingRangeKindSupportCapabilities foldingRangeKind)

Specific options for the folding range kind.

public void
setLineFoldingOnly(final Boolean lineFoldingOnly)

If set, the client signals that it only supports folding complete lines.

public void
setRangeLimit(final Integer rangeLimit)

The maximum number of folding ranges that the client prefers to receive per document.

public String
toString()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.toString.

Returns a string representation of the object.

Inherited from org.eclipse.lsp4j.DynamicRegistrationCapabilities:
getDynamicRegistrationsetDynamicRegistration

Field Detail

foldingRangeback to summary
private FoldingRangeSupportCapabilities foldingRange

Specific options for the folding range.

Since 3.17.0

foldingRangeKindback to summary
private FoldingRangeKindSupportCapabilities foldingRangeKind

Specific options for the folding range kind.

Since 3.17.0

lineFoldingOnlyback to summary
private Boolean lineFoldingOnly

If set, the client signals that it only supports folding complete lines. If set, client will ignore specified FoldingRange#startCharacter and FoldingRange#endCharacter properties.

rangeLimitback to summary
private Integer rangeLimit

The maximum number of folding ranges that the client prefers to receive per document. The value serves as a hint, servers are free to follow the limit.

Constructor Detail

FoldingRangeCapabilitiesback to summary
public FoldingRangeCapabilities()

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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
getFoldingRangeback to summary
public FoldingRangeSupportCapabilities getFoldingRange()

Specific options for the folding range.

Since 3.17.0

getFoldingRangeKindback to summary
public FoldingRangeKindSupportCapabilities getFoldingRangeKind()

Specific options for the folding range kind.

Since 3.17.0

getLineFoldingOnlyback to summary
public Boolean getLineFoldingOnly()

If set, the client signals that it only supports folding complete lines. If set, client will ignore specified FoldingRange#startCharacter and FoldingRange#endCharacter properties.

getRangeLimitback to summary
public Integer getRangeLimit()

The maximum number of folding ranges that the client prefers to receive per document. The value serves as a hint, servers are free to follow the limit.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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
setFoldingRangeback to summary
public void setFoldingRange(final FoldingRangeSupportCapabilities foldingRange)

Specific options for the folding range.

Since 3.17.0

setFoldingRangeKindback to summary
public void setFoldingRangeKind(final FoldingRangeKindSupportCapabilities foldingRangeKind)

Specific options for the folding range kind.

Since 3.17.0

setLineFoldingOnlyback to summary
public void setLineFoldingOnly(final Boolean lineFoldingOnly)

If set, the client signals that it only supports folding complete lines. If set, client will ignore specified FoldingRange#startCharacter and FoldingRange#endCharacter properties.

setRangeLimitback to summary
public void setRangeLimit(final Integer rangeLimit)

The maximum number of folding ranges that the client prefers to receive per document. The value serves as a hint, servers are free to follow the limit.

toStringback to summary
public String toString()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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