Class CodeVisibility

java.lang.Object

io.github.mmm.code.api.modifier.CodeVisibility

All Implemented Interfaces:

Comparable<CodeVisibility>

public class CodeVisibility
extends Object
implements Comparable<CodeVisibility>

Represents the visibility of a CodeMethod.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static final CodeVisibility	DEFAULT	CodeVisibility for default access (no/empty modifier).
static final CodeVisibility	PRIVATE	CodeVisibility for private access.
static final CodeVisibility	PROTECTED	CodeVisibility for protected access.
static final CodeVisibility	PUBLIC	CodeVisibility for public access.

Constructor Summary

Constructors

Constructor	Description
CodeVisibility(String value, int order)	The constructor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(CodeVisibility visibility)
boolean	equals(Object obj)
int	getOrder()
int	hashCode()
boolean	isStrongerOrEqualTo(CodeVisibility visibility)
boolean	isWeakerOrEqualTo(CodeVisibility visibility)
static CodeVisibility	of(int javaModifiers)
static CodeVisibility	of(String visiblity)
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PUBLIC

public static final CodeVisibility PUBLIC

CodeVisibility for public access.

PRIVATE

public static final CodeVisibility PRIVATE

CodeVisibility for private access.

PROTECTED

public static final CodeVisibility PROTECTED

CodeVisibility for protected access.

DEFAULT

public static final CodeVisibility DEFAULT

CodeVisibility for default access (no/empty modifier).

Constructor Details

CodeVisibility

public CodeVisibility(String value,
 int order)

The constructor. Only use to declare new constants.

Parameters:

value - the visibility as String.

order - the order.

Method Details

getOrder

public int getOrder()

Returns:

the order

isStrongerOrEqualTo

public boolean isStrongerOrEqualTo(CodeVisibility visibility)

Parameters:

visibility - the CodeVisibility to compare to.

Returns:

true if this CodeVisibility is stronger or equal to the given visibility, false otherwise. E.g. PRIVATE is stronger than PUBLIC.

isWeakerOrEqualTo

public boolean isWeakerOrEqualTo(CodeVisibility visibility)

Parameters:

visibility - the CodeVisibility to compare to.

Returns:

true if this CodeVisibility is weaker or equal to the given visibility, false otherwise. E.g. PUBLIC is weaker than PRIVATE.

compareTo

public int compareTo(CodeVisibility visibility)

Specified by:

compareTo in interface Comparable<CodeVisibility>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static CodeVisibility of(int javaModifiers)

Parameters:

javaModifiers - the Java Modifier mask.

Returns:

the given Modifier mask as CodeModifiers.

of

public static CodeVisibility of(String visiblity)

Parameters:

visiblity - the string representation of the potential CodeVisibility

Returns:

the according CodeVisibility or null if not known.