com.github.aliteralmind.codelet.taglet

Enum IncludePostClassName

java.lang.Object

java.lang.Enum<IncludePostClassName>

com.github.aliteralmind.codelet.taglet.IncludePostClassName

All Implemented Interfaces:

Serializable, Comparable<IncludePostClassName>

public enum IncludePostClassName
extends Enum<IncludePostClassName>

Should the class-generics or the function-name-and-parameters be included in the enclosing classes simple name?.

Since:

0.1.0

Author:

Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. http://codelet.aliteralmind.com, https://github.com/aliteralmind/codelet

See Also:

ComSunJavaDocUtil.getEnclosingSimpleName(Tag, IncludePostClassName)

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO YYY.
YES YYY.

Method Summary

Methods

Modifier and Type	Method and Description
static IncludePostClassName	getForBoolean(boolean flag) Return IncludePostClassName.YES if the flag is true, or NO if false.
boolean	isNo() Is this IncludePostClassName equal to NO?.
boolean	isYes() Is this IncludePostClassName equal to YES?.
static IncludePostClassName	valueOf(String name) Returns the enum constant of this type with the specified name.
static IncludePostClassName[]	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

Enum Constant Detail

YES

public static final IncludePostClassName YES

YYY.

See Also:

NO, isYes()

NO

public static final IncludePostClassName NO

YYY.

See Also:

YES, isNo()

Method Detail

values

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

Returns:

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

valueOf

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

isYes

public final boolean isYes()

Is this IncludePostClassName equal to YES?.

Returns:

this == YES

See Also:

isNo()

isNo

public final boolean isNo()

Is this IncludePostClassName equal to NO?.

Returns:

this == NO

See Also:

isYes()

getForBoolean

public static final IncludePostClassName getForBoolean(boolean flag)

Return IncludePostClassName.YES if the flag is true, or NO if false.

Returns:

(flag ? YES : NO)