com.jaxio.celerio.convention

Enum CommentStyle

java.lang.Object

java.lang.Enum<CommentStyle>

com.jaxio.celerio.convention.CommentStyle

All Implemented Interfaces:

Serializable, Comparable<CommentStyle>

public enum CommentStyle
extends Enum<CommentStyle>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DASH
DOUBLE_DASH
DOUBLE_QUOTE
DOUBLE_SLASH
DOUBLE_TILDE
JAVA
JAVADOC
JSP
XML

Method Summary

Methods

Modifier and Type	Method and Description
String	decorate(Iterable<String> lines)
String	decorate(Iterable<String> lines, String preprend)
String	decorate(String line, String prepend)
static CommentStyle	fromFilename(String filename)
String	getEnd()
List<String>	getExtensions()
String	getStart()
String	getStartLine()
void	setEnd(String end)
void	setExtensions(List<String> extensions)
void	setStart(String start)
void	setStartLine(String startLine)
static CommentStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommentStyle[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JAVA

public static final CommentStyle JAVA

JAVADOC

public static final CommentStyle JAVADOC

JSP

public static final CommentStyle JSP

XML

public static final CommentStyle XML

DOUBLE_DASH

public static final CommentStyle DOUBLE_DASH

DASH

public static final CommentStyle DASH

DOUBLE_QUOTE

public static final CommentStyle DOUBLE_QUOTE

DOUBLE_TILDE

public static final CommentStyle DOUBLE_TILDE

DOUBLE_SLASH

public static final CommentStyle DOUBLE_SLASH

Method Detail

values

public static CommentStyle[] 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 (CommentStyle c : CommentStyle.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommentStyle 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

decorate

public String decorate(String line,
              String prepend)

decorate

public String decorate(Iterable<String> lines)

decorate

public String decorate(Iterable<String> lines,
              String preprend)

fromFilename

public static CommentStyle fromFilename(String filename)

getStart

public String getStart()

setStart

public void setStart(String start)

getStartLine

public String getStartLine()

setStartLine

public void setStartLine(String startLine)

getEnd

public String getEnd()

setEnd

public void setEnd(String end)

getExtensions

public List<String> getExtensions()

setExtensions

public void setExtensions(List<String> extensions)