Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class MarkdownCapabilities

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

Client capabilities specific to the used markdown parser.

Since 3.16.0

Field Summary

Modifier and TypeField and Description
private List<String>
allowedTags

A list of HTML tags that the client allows / supports in Markdown.

private String
parser

The name of the parser.

private String
version

The version of the parser.

Constructor Summary

AccessConstructor and Description
public
public
public
MarkdownCapabilities(final String parser, final String version)

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 List<String>
getAllowedTags()

A list of HTML tags that the client allows / supports in Markdown.

public String
getParser()

The name of the parser.

public String
getVersion()

The version of the parser.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setAllowedTags(final List<String> allowedTags)

A list of HTML tags that the client allows / supports in Markdown.

public void
setParser(final String parser)

The name of the parser.

public void
setVersion(final String version)

The version of the parser.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

allowedTagsback to summary
private List<String> allowedTags

A list of HTML tags that the client allows / supports in Markdown.

Since 3.17.0

parserback to summary
private String parser

The name of the parser.

Annotations
@NonNull
versionback to summary
private String version

The version of the parser.

Constructor Detail

MarkdownCapabilitiesback to summary
public MarkdownCapabilities()
MarkdownCapabilitiesback to summary
public MarkdownCapabilities(final String parser)
MarkdownCapabilitiesback to summary
public MarkdownCapabilities(final String parser, final String version)

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
getAllowedTagsback to summary
public List<String> getAllowedTags()

A list of HTML tags that the client allows / supports in Markdown.

Since 3.17.0

getParserback to summary
public String getParser()

The name of the parser.

Annotations
@NonNull
getVersionback to summary
public String getVersion()

The version of the parser.

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
setAllowedTagsback to summary
public void setAllowedTags(final List<String> allowedTags)

A list of HTML tags that the client allows / supports in Markdown.

Since 3.17.0

setParserback to summary
public void setParser(final String parser)

The name of the parser.

setVersionback to summary
public void setVersion(final String version)

The version of the parser.

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