sirius.tagliatelle

Class TemplateArgument

java.lang.Object

sirius.tagliatelle.TemplateArgument

public class TemplateArgument
extends Object

Represents an argument definition for a template.

Constructor Summary

Constructors

Constructor and Description
TemplateArgument(Class<?> type, String name, String description) Creates a new argument with the given type, name and default expression.
TemplateArgument(Class<?> type, String name, String description, Expression defaultValue, String deprecationWarning) Creates a new argument with the given type, name and default expression.

Method Summary

Modifier and Type	Method and Description
Expression	getDefaultValue() Returns the default value.
String	getDeprecationWarning() Returns a deprecation warning if present.
String	getDescription() Returns the description of the argument.
String	getName() Returns the name of the argument.
Class<?>	getType() Returns the type of the argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateArgument

public TemplateArgument(Class<?> type,
                        String name,
                        @Nullable
                        String description,
                        @Nullable
                        Expression defaultValue,
                        @Nullable
                        String deprecationWarning)

Creates a new argument with the given type, name and default expression.

Parameters:

type - the type of the argument

name - the name of the argument

description - a description of the argument

defaultValue - the expression which yields the default value if no argument is supplied.

deprecationWarning - a deprecation warning if the parameter is not to be used

TemplateArgument

public TemplateArgument(Class<?> type,
                        String name,
                        @Nullable
                        String description)

Creates a new argument with the given type, name and default expression.

Parameters:

type - the type of the argument

name - the name of the argument

description - a description of the argument

Method Detail

getType

public Class<?> getType()

Returns the type of the argument.

Returns:

the type of the argument

getName

public String getName()

Returns the name of the argument.

Returns:

the name of the argument

getDefaultValue

public Expression getDefaultValue()

Returns the default value.

Returns:

the expression which yields the default value if not argument is given

getDescription

public String getDescription()

Returns the description of the argument.

Returns:

a short description of the argument

getDeprecationWarning

public String getDeprecationWarning()

Returns a deprecation warning if present.

Returns:

a deprecation warning if present, null otherwise