Module com.speedment.common.codegen

Package com.speedment.common.codegen.constant

Enum DefaultJavadocTag

java.lang.Object

java.lang.Enum<DefaultJavadocTag>

com.speedment.common.codegen.constant.DefaultJavadocTag

All Implemented Interfaces:

JavadocTag, HasCall<JavadocTag>, HasCopy<JavadocTag>, HasImports<JavadocTag>, HasName<JavadocTag>, Serializable, Comparable<DefaultJavadocTag>

public enum DefaultJavadocTag
extends Enum<DefaultJavadocTag>
implements JavadocTag

Author:

Emil Forslund

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHOR
DEPRECATED
PARAM
RETURN
SEE
SINCE
THROWS
VERSION

Method Summary

Modifier and Type	Method	Description
JavadocTag	call(Consumer<JavadocTag> procedure)	Calls the specified Consumer with this object as the parameter.
JavadocTag	copy()	Create a deep copy of this model if it is mutable.
List<Import>	getImports()	Returns a list of all imports in this model.
String	getName()	Returns the name of this model.
Optional<String>	getText()	Returns the text of this javadoc tag.
Optional<String>	getValue()	Returns the value of this javadoc tag.
JavadocTag	setName(String name)	Sets the name of this model.
JavadocTag	setText(String text)	Sets the text of this javadoc tag.
JavadocTag	setValue(String value)	Sets the value of this javadoc tag.
static DefaultJavadocTag	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DefaultJavadocTag[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.speedment.common.codegen.model.trait.HasCall

call

Methods inherited from interface com.speedment.common.codegen.model.trait.HasImports

add, imports, imports, imports

Enum Constant Detail

PARAM

public static final DefaultJavadocTag PARAM

AUTHOR

public static final DefaultJavadocTag AUTHOR

DEPRECATED

public static final DefaultJavadocTag DEPRECATED

RETURN

public static final DefaultJavadocTag RETURN

SEE

public static final DefaultJavadocTag SEE

THROWS

public static final DefaultJavadocTag THROWS

SINCE

public static final DefaultJavadocTag SINCE

VERSION

public static final DefaultJavadocTag VERSION

Method Detail

values

public static DefaultJavadocTag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DefaultJavadocTag c : DefaultJavadocTag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DefaultJavadocTag valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

setName

public JavadocTag setName(String name)

Sets the name of this model.

This must not be null!

Since this is a constant, the model will first be copied and the operation will then be performed on the copy.

Specified by:

setName in interface HasName<JavadocTag>

Parameters:

name - the new name (not null!)

Returns:

a reference to this

setValue

public JavadocTag setValue(String value)

Sets the value of this javadoc tag. In the following examples, the value is the "foo" part:

     @param foo bar
     @return foo
 

Since this is a constant, the model will first be copied and the operation will then be performed on the copy.

Specified by:

setValue in interface JavadocTag

Parameters:

value - the new value

Returns:

a reference to this model

setText

public JavadocTag setText(String text)

Sets the text of this javadoc tag. In the following examples, the text is the "bar" part:

     @param foo bar
     @return foo
 

Since this is a constant, the model will first be copied and the operation will then be performed on the copy.

Specified by:

setText in interface JavadocTag

Parameters:

text - the new text

Returns:

a reference to this model

call

public JavadocTag call(Consumer<JavadocTag> procedure)

Calls the specified Consumer with this object as the parameter. This method exists so that methods can operate on an object without breaking the flow.

Since this is a constant, the model will first be copied and the operation will then be performed on the copy.

Specified by:

call in interface HasCall<JavadocTag>

Parameters:

procedure - the procedure to call

Returns:

a reference to this

getName

public String getName()

Description copied from interface: HasName

Returns the name of this model.

Specified by:

getName in interface HasName<JavadocTag>

Returns:

the name

getValue

public Optional<String> getValue()

Description copied from interface: JavadocTag

Returns the value of this javadoc tag. In the following examples, the value is the "foo" part:

     @param foo bar
     @return foo
 

Specified by:

getValue in interface JavadocTag

Returns:

the value part of the tag or empty if none exists

getText

public Optional<String> getText()

Description copied from interface: JavadocTag

Returns the text of this javadoc tag. In the following examples, the text is the "bar" part:

     @param foo bar
     @return foo
 

Specified by:

getText in interface JavadocTag

Returns:

the text part of the tag or empty if none exists

getImports

public List<Import> getImports()

Description copied from interface: HasImports

Returns a list of all imports in this model.

The list returned must be mutable for changes!

Specified by:

getImports in interface HasImports<JavadocTag>

Returns:

the imports

copy

public JavadocTag copy()

Description copied from interface: HasCopy

Create a deep copy of this model if it is mutable. If this class is not mutable, then this method may return itself. If the model implements HasParent, then the parent property will not be copied. Instead it will be set to null.

Specified by:

copy in interface HasCopy<JavadocTag>

Returns:

the copy