com.github.aliteralmind.codelet.util

Enum BlackOrWhite

java.lang.Object

java.lang.Enum<BlackOrWhite>

com.github.aliteralmind.codelet.util.BlackOrWhite

All Implemented Interfaces:

Serializable, Comparable<BlackOrWhite>

public enum BlackOrWhite
extends Enum<BlackOrWhite>

Is it a blacklist or whitelist?.

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:

FilenameBlackWhiteList

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLACK YYY.
WHITE YYY.

Method Summary

Methods

Modifier and Type	Method and Description
static BlackOrWhite	getBlackIfTrue(boolean flag) Return BlackOrWhite.BLACK if the flag is true, or WHITE if false.
boolean	isBlack() Is this BlackOrWhite equal to BLACK?.
boolean	isWhite() Is this BlackOrWhite equal to WHITE?.
static BlackOrWhite	valueOf(String name) Returns the enum constant of this type with the specified name.
static BlackOrWhite[]	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

BLACK

public static final BlackOrWhite BLACK

YYY.

See Also:

WHITE, isBlack()

WHITE

public static final BlackOrWhite WHITE

YYY.

See Also:

BLACK, isWhite()

Method Detail

values

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

Returns:

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

valueOf

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

isBlack

public final boolean isBlack()

Is this BlackOrWhite equal to BLACK?.

Returns:

this == BLACK

See Also:

isWhite()

isWhite

public final boolean isWhite()

Is this BlackOrWhite equal to WHITE?.

Returns:

this == WHITE

See Also:

isBlack()

getBlackIfTrue

public static final BlackOrWhite getBlackIfTrue(boolean flag)

Return BlackOrWhite.BLACK if the flag is true, or WHITE if false.

Returns:

(flag ? BLACK : WHITE)