package saker.build.scripting.model.info
Provides information about a specific script literal.
Literals are the unit of information that can be declared in a script source code. This interface can provide information about a literal and its type.
public default FormattedTextContent | Gets information about this literal. |
public String | Gets a string representation of the literal. |
public default String | Gets the relation of this literal. |
public default TypeInformation | getType() Gets the type of the literal. |
public default boolean | Gets if the literal is deprecated. |
Gets information about this literal.
The information should contain general description about the literal, its context, and what it represents.
The information about this literal.
Gets a string representation of the literal.
The string representation of the literal.
Gets the relation of this literal.
Relation is a short information about associated with the literal. It is optional and in most cases the type information is enough. However, in some cases it might be useful for the user to provide additional information related to the literal.
The returned string should be short, fit on a single line.
The relation of the literal or
null
if none.Gets the type of the literal.
The type of the literal or
null
if not available.Gets if the literal is deprecated.
true
if the literal is deprecated.