hr.ngs.templater

Class EditorConfigurationBuilder.TagMetadata

java.lang.Object

hr.ngs.templater.EditorConfigurationBuilder.TagMetadata

Enclosing interface:

EditorConfigurationBuilder

public static class EditorConfigurationBuilder.TagMetadata
extends java.lang.Object

Additional metadata available in Templater Editor. This is available in tag search/listing to provide more information about the tag to the user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditorConfigurationBuilder.TagMetadata.Builder Builder helper for metadata construction

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Class<?>	actualType When type is not really known or specific type should be used instead, actual type can be specified to be used instead of the one Templater detected.
java.lang.String	category Category which can be used for grouping tags.
java.lang.String	description Description of the tag explaining its purpose.
java.lang.String	example Value example used for this tag.
EditorConfigurationBuilder.TagStatus	status Status of the tag.

Constructor Summary

Constructors

Constructor and Description
TagMetadata(EditorConfigurationBuilder.TagStatus status, java.lang.Class<?> actualType, java.lang.String description, java.lang.String example, java.lang.String category) Create tag metadata description.

Method Summary

Modifier and Type	Method and Description
static EditorConfigurationBuilder.TagMetadata.Builder	builder() Helper builder for constructing tag metadata

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

status

public final EditorConfigurationBuilder.TagStatus status

Status of the tag. Inactive tags are hidden by default.

actualType

public final java.lang.Class<?> actualType

When type is not really known or specific type should be used instead, actual type can be specified to be used instead of the one Templater detected. This is useful in dynamic scenarios when Templater is unable to pick the best type, such as processing JSON.

It's also useful when there is type conversion going on, where some other type will actually be processed, instead of the one defined in the type signature due to low-level plugins.

description

public final java.lang.String description

Description of the tag explaining its purpose.

example

public final java.lang.String example

Value example used for this tag.

category

public final java.lang.String category

Category which can be used for grouping tags.

Constructor Detail

TagMetadata

public TagMetadata(EditorConfigurationBuilder.TagStatus status,
                   java.lang.Class<?> actualType,
                   java.lang.String description,
                   java.lang.String example,
                   java.lang.String category)

Create tag metadata description. All parameters are optional (can be null). Null status will default to Active.

Parameters:

status - status of the tag

actualType - when custom type will actually be used

description - description of the tag

example - value example for the tag

category - category of the tag

Method Detail

builder

public static EditorConfigurationBuilder.TagMetadata.Builder builder()

Helper builder for constructing tag metadata

Returns:

tag metadata builder