Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class Hover

extends Object
Class Inheritance
Annotations
@JsonAdapter:Factory
@SuppressWarnings:all
Imports
com.google.gson.annotations.JsonAdapter, java.util.Arrays, .List, org.eclipse.lsp4j.adapters.HoverTypeAdapter, org.eclipse.lsp4j.jsonrpc.messages.Either, org.eclipse.lsp4j.jsonrpc.util.Preconditions, .ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull
The result of a hover request.

Field Summary

Modifier and TypeField and Description
private Either<List<Either<String, MarkedString>>, MarkupContent>
contents

The hover's content as markdown

private Range
range

An optional range

Constructor Summary

AccessConstructor and Description
public
Hover()

public
Hover(final List<Either<String, MarkedString>> contents)

public
Hover(final List<Either<String, MarkedString>> contents, final Range range)

public
Hover(final MarkupContent contents)

public
Hover(final MarkupContent contents, final Range range)

public
Hover(final Either<String, MarkedString> contents)

Method Summary

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

Overrides java.lang.Object.equals.

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

public Either<List<Either<String, MarkedString>>, MarkupContent>
getContents()

The hover's content as markdown

public Range
getRange()

An optional range

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setContents(final Either<List<Either<String, MarkedString>>, MarkupContent> contents)

The hover's content as markdown

public void
setContents(final List<Either<String, MarkedString>> contents)

public void
setContents(final MarkupContent contents)

public void
setRange(final Range range)

An optional range

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

contentsback to summary
private Either<List<Either<String, MarkedString>>, MarkupContent> contents

The hover's content as markdown

Annotations
@NonNull
rangeback to summary
private Range range

An optional range

Constructor Detail

Hoverback to summary
public Hover()
Hoverback to summary
public Hover(final List<Either<String, MarkedString>> contents)
Hoverback to summary
public Hover(final List<Either<String, MarkedString>> contents, final Range range)
Hoverback to summary
public Hover(final MarkupContent contents)
Hoverback to summary
public Hover(final MarkupContent contents, final Range range)
Hoverback to summary
public Hover(final Either<String, MarkedString> contents)

Method Detail

equalsback 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
getContentsback to summary
public Either<List<Either<String, MarkedString>>, MarkupContent> getContents()

The hover's content as markdown

Annotations
@NonNull
getRangeback to summary
public Range getRange()

An optional range

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.
Annotations
@Override
setContentsback to summary
public void setContents(final Either<List<Either<String, MarkedString>>, MarkupContent> contents)

The hover's content as markdown

setContentsback to summary
public void setContents(final List<Either<String, MarkedString>> contents)
setContentsback to summary
public void setContents(final MarkupContent contents)
setRangeback to summary
public void setRange(final Range range)

An optional range

toStringback 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