Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class Moniker

extends Object
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
org.eclipse.lsp4j.jsonrpc.util.Preconditions, .ToStringBuilder, org.eclipse.lsp4j.jsonrpc.validation.NonNull

Moniker definition to match LSIF 0.5 moniker definition.

Since 3.16.0

Field Summary

Modifier and TypeField and Description
private String
identifier

The identifier of the moniker.

private String
kind

The moniker kind if known.

private String
scheme

The scheme of the moniker.

private String
unique

The scope in which the moniker is unique.

Constructor Summary

AccessConstructor and Description
public
public
Moniker(final String scheme, final String identifier, final String unique)

public
Moniker(final String scheme, final String identifier, final String unique, final String kind)

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
getIdentifier()

The identifier of the moniker.

public String
getKind()

The moniker kind if known.

public String
getScheme()

The scheme of the moniker.

public String
getUnique()

The scope in which the moniker is unique.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setIdentifier(final String identifier)

The identifier of the moniker.

public void
setKind(final String kind)

The moniker kind if known.

public void
setScheme(final String scheme)

The scheme of the moniker.

public void
setUnique(final String unique)

The scope in which the moniker is unique.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

identifierback to summary
private String identifier

The identifier of the moniker. The value is opaque in LSIF however schema owners are allowed to define the structure if they want.

Annotations
@NonNull
kindback to summary
private String kind

The moniker kind if known. Values are taken from MonikerKind.

schemeback to summary
private String scheme

The scheme of the moniker. For example tsc or .Net

Annotations
@NonNull
uniqueback to summary
private String unique

The scope in which the moniker is unique. Values are taken from UniquenessLevel.

Annotations
@NonNull

Constructor Detail

Monikerback to summary
public Moniker()
Monikerback to summary
public Moniker(final String scheme, final String identifier, final String unique)
Monikerback to summary
public Moniker(final String scheme, final String identifier, final String unique, final String kind)

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
getIdentifierback to summary
public String getIdentifier()

The identifier of the moniker. The value is opaque in LSIF however schema owners are allowed to define the structure if they want.

Annotations
@NonNull
getKindback to summary
public String getKind()

The moniker kind if known. Values are taken from MonikerKind.

getSchemeback to summary
public String getScheme()

The scheme of the moniker. For example tsc or .Net

Annotations
@NonNull
getUniqueback to summary
public String getUnique()

The scope in which the moniker is unique. Values are taken from UniquenessLevel.

Annotations
@NonNull
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
setIdentifierback to summary
public void setIdentifier(final String identifier)

The identifier of the moniker. The value is opaque in LSIF however schema owners are allowed to define the structure if they want.

setKindback to summary
public void setKind(final String kind)

The moniker kind if known. Values are taken from MonikerKind.

setSchemeback to summary
public void setScheme(final String scheme)

The scheme of the moniker. For example tsc or .Net

setUniqueback to summary
public void setUnique(final String unique)

The scope in which the moniker is unique. Values are taken from UniquenessLevel.

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