Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class Registration

extends Object
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
com.google.gson.annotations.JsonAdapter, org.eclipse.lsp4j.jsonrpc.json.adapters.JsonElementTypeAdapter, org.eclipse.lsp4j.jsonrpc.util.Preconditions, .ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull

General parameters to register for a capability.

Field Summary

Modifier and TypeField and Description
private String
id

The id used to register the request.

private String
method

The method / capability to register for.

private Object
registerOptions

Options necessary for the registration.

Constructor Summary

AccessConstructor and Description
public
public
Registration(final String id, final String method)

public
Registration(final String id, final String method, final Object registerOptions)

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 String
getId()

The id used to register the request.

public String
getMethod()

The method / capability to register for.

public Object
getRegisterOptions()

Options necessary for the registration.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setId(final String id)

The id used to register the request.

public void
setMethod(final String method)

The method / capability to register for.

public void
setRegisterOptions(final Object registerOptions)

Options necessary for the registration.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

idback to summary
private String id

The id used to register the request. The id can be used to deregister the request again.

Annotations
@NonNull
methodback to summary
private String method

The method / capability to register for.

Annotations
@NonNull
registerOptionsback to summary
private Object registerOptions

Options necessary for the registration.

Annotations
@JsonAdapter:Factory

Constructor Detail

Registrationback to summary
public Registration()
Registrationback to summary
public Registration(final String id, final String method)
Registrationback to summary
public Registration(final String id, final String method, final Object registerOptions)

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
getIdback to summary
public String getId()

The id used to register the request. The id can be used to deregister the request again.

Annotations
@NonNull
getMethodback to summary
public String getMethod()

The method / capability to register for.

Annotations
@NonNull
getRegisterOptionsback to summary
public Object getRegisterOptions()

Options necessary for the registration.

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
setIdback to summary
public void setId(final String id)

The id used to register the request. The id can be used to deregister the request again.

setMethodback to summary
public void setMethod(final String method)

The method / capability to register for.

setRegisterOptionsback to summary
public void setRegisterOptions(final Object registerOptions)

Options necessary for the registration.

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