Class CodeModifiers

java.lang.Object

io.github.mmm.code.api.modifier.CodeModifiers

public class CodeModifiers
extends Object

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 String	KEY_ABSTRACT	The modifier "abstract".
static final String	KEY_DEFAULT	The modifier "default".
static final String	KEY_FINAL	The modifier "final".
static final String	KEY_NATIVE	The modifier "native".
static final String	KEY_STATIC	The modifier "static".
static final String	KEY_SYNCHRONIZED	The modifier "synchronized".
static final String	KEY_TRANSIENT	The modifier "transient".
static final String	KEY_VOLATILE	The modifier "volatile".
static final CodeModifiers	MODIFIERS	CodeModifiers that is empty (no modifiers).
static final CodeModifiers	MODIFIERS_FINAL	CodeModifiers for final.
static final CodeModifiers	MODIFIERS_PRIVATE	CodeModifiers for private.
static final CodeModifiers	MODIFIERS_PRIVATE_ABSTRACT	CodeModifiers for private abstract.
static final CodeModifiers	MODIFIERS_PRIVATE_FINAL	CodeModifiers for private final.
static final CodeModifiers	MODIFIERS_PRIVATE_STATIC	CodeModifiers for private static.
static final CodeModifiers	MODIFIERS_PRIVATE_STATIC_FINAL	CodeModifiers for private static final.
static final CodeModifiers	MODIFIERS_PROTECTED	CodeModifiers for protected.
static final CodeModifiers	MODIFIERS_PROTECTED_ABSTRACT	CodeModifiers for protected abstract.
static final CodeModifiers	MODIFIERS_PROTECTED_FINAL	CodeModifiers for protected final.
static final CodeModifiers	MODIFIERS_PROTECTED_STATIC	CodeModifiers for protected static.
static final CodeModifiers	MODIFIERS_PROTECTED_STATIC_FINAL	CodeModifiers for protected static final.
static final CodeModifiers	MODIFIERS_PUBLIC	CodeModifiers for public.
static final CodeModifiers	MODIFIERS_PUBLIC_ABSTRACT	CodeModifiers for public abstract.
static final CodeModifiers	MODIFIERS_PUBLIC_DEFAULT	CodeModifiers for public default.
static final CodeModifiers	MODIFIERS_PUBLIC_FINAL	CodeModifiers for public final.
static final CodeModifiers	MODIFIERS_PUBLIC_STATIC	CodeModifiers for public static.
static final CodeModifiers	MODIFIERS_PUBLIC_STATIC_FINAL	CodeModifiers for public static final.
static final CodeModifiers	MODIFIERS_STATIC	CodeModifiers for static.
static final CodeModifiers	MODIFIERS_STATIC_FINAL	CodeModifiers for static final.

Constructor Summary

Constructors

Constructor	Description
CodeModifiers(CodeVisibility visibility, String... modifiers)	The constructor.
CodeModifiers(CodeVisibility visibility, Collection<String> modifiers)	The constructor.

Method Summary

Modifier and Type	Method	Description
CodeModifiers	addModifier(String modifier)
CodeModifiers	changeVisibility(CodeVisibility newVisibility)
boolean	equals(Object obj)
void	formatModifiers(Appendable buffer)
Set<String>	getModifiers()
CodeVisibility	getVisibility()
int	hashCode()
boolean	isAbstract()
boolean	isDefaultModifier()
boolean	isDefaultVisibility()
boolean	isFinal()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isStatic()
static CodeModifiers	of(int javaModifiers)
static CodeModifiers	of(int javaModifiers, boolean defaultMethod)
CodeModifiers	removeModifier(String modifier)
String	toString()

Methods inherited from class Object

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

Field Details

KEY_STATIC

public static final String KEY_STATIC

The modifier "static".

See Also:

• Constant Field Values

KEY_FINAL

public static final String KEY_FINAL

The modifier "final".

See Also:

• Constant Field Values

KEY_ABSTRACT

public static final String KEY_ABSTRACT

The modifier "abstract".

See Also:

• Constant Field Values

KEY_VOLATILE

public static final String KEY_VOLATILE

The modifier "volatile".

See Also:

• Constant Field Values

KEY_TRANSIENT

public static final String KEY_TRANSIENT

The modifier "transient".

See Also:

• Constant Field Values

KEY_NATIVE

public static final String KEY_NATIVE

The modifier "native".

See Also:

• Constant Field Values

KEY_SYNCHRONIZED

public static final String KEY_SYNCHRONIZED

The modifier "synchronized".

See Also:

• Constant Field Values

KEY_DEFAULT

public static final String KEY_DEFAULT

The modifier "default".

See Also:

• Method.isDefault()
• Constant Field Values

MODIFIERS_PUBLIC

public static final CodeModifiers MODIFIERS_PUBLIC

CodeModifiers for public.

MODIFIERS_PUBLIC_ABSTRACT

public static final CodeModifiers MODIFIERS_PUBLIC_ABSTRACT

CodeModifiers for public abstract.

MODIFIERS_PUBLIC_STATIC

public static final CodeModifiers MODIFIERS_PUBLIC_STATIC

CodeModifiers for public static.

MODIFIERS_PUBLIC_STATIC_FINAL

public static final CodeModifiers MODIFIERS_PUBLIC_STATIC_FINAL

CodeModifiers for public static final.

MODIFIERS_PUBLIC_FINAL

public static final CodeModifiers MODIFIERS_PUBLIC_FINAL

CodeModifiers for public final.

MODIFIERS_PRIVATE

public static final CodeModifiers MODIFIERS_PRIVATE

CodeModifiers for private.

MODIFIERS_PRIVATE_ABSTRACT

public static final CodeModifiers MODIFIERS_PRIVATE_ABSTRACT

CodeModifiers for private abstract.

MODIFIERS_PRIVATE_STATIC

public static final CodeModifiers MODIFIERS_PRIVATE_STATIC

CodeModifiers for private static.

MODIFIERS_PRIVATE_STATIC_FINAL

public static final CodeModifiers MODIFIERS_PRIVATE_STATIC_FINAL

CodeModifiers for private static final.

MODIFIERS_PRIVATE_FINAL

public static final CodeModifiers MODIFIERS_PRIVATE_FINAL

CodeModifiers for private final.

MODIFIERS_PROTECTED

public static final CodeModifiers MODIFIERS_PROTECTED

CodeModifiers for protected.

MODIFIERS_PROTECTED_ABSTRACT

public static final CodeModifiers MODIFIERS_PROTECTED_ABSTRACT

CodeModifiers for protected abstract.

MODIFIERS_PROTECTED_STATIC

public static final CodeModifiers MODIFIERS_PROTECTED_STATIC

CodeModifiers for protected static.

MODIFIERS_PROTECTED_STATIC_FINAL

public static final CodeModifiers MODIFIERS_PROTECTED_STATIC_FINAL

CodeModifiers for protected static final.

MODIFIERS_PROTECTED_FINAL

public static final CodeModifiers MODIFIERS_PROTECTED_FINAL

CodeModifiers for protected final.

MODIFIERS

public static final CodeModifiers MODIFIERS

CodeModifiers that is empty (no modifiers).

MODIFIERS_STATIC

public static final CodeModifiers MODIFIERS_STATIC

CodeModifiers for static.

MODIFIERS_STATIC_FINAL

public static final CodeModifiers MODIFIERS_STATIC_FINAL

CodeModifiers for static final.

MODIFIERS_FINAL

public static final CodeModifiers MODIFIERS_FINAL

CodeModifiers for final.

MODIFIERS_PUBLIC_DEFAULT

public static final CodeModifiers MODIFIERS_PUBLIC_DEFAULT

CodeModifiers for public default.

Constructor Details

CodeModifiers

public CodeModifiers(CodeVisibility visibility,
 String... modifiers)

The constructor.

Parameters:

visibility - the Visibility.

modifiers - the additional modifiers.

CodeModifiers

public CodeModifiers(CodeVisibility visibility,
 Collection<String> modifiers)

The constructor.

Parameters:

visibility - the CodeVisibility.

modifiers - the modifiers excluding the CodeVisibility.

Method Details

getVisibility

public CodeVisibility getVisibility()

Returns:

the CodeVisibility.

getModifiers

public Set<String> getModifiers()

Returns:

the Set with all modifiers (not including the visibility).

addModifier

public CodeModifiers addModifier(String modifier)

Parameters:

modifier - the modifier to add.

Returns:

this CodeModifiers if the given modifier is already contained or a new instance of CodeModifiers with the given modifier.

removeModifier

public CodeModifiers removeModifier(String modifier)

Parameters:

modifier - the modifier to remove.

Returns:

this CodeModifiers if the given modifier is not contained or a new instance of CodeModifiers without the given modifier.

changeVisibility

public CodeModifiers changeVisibility(CodeVisibility newVisibility)

Parameters:

newVisibility - the new visibility

Returns:

this CodeModifiers if it already has the given CodeVisibility or a new instance of CodeModifiers with the given CodeVisibility.

isAbstract

public boolean isAbstract()

Returns:

true if abstract.

isStatic

public boolean isStatic()

Returns:

true if static.

isFinal

public boolean isFinal()

Returns:

true if final.

isDefaultModifier

public boolean isDefaultModifier()

Returns:

true if default (e.g. for default methods), false otherwise.

See Also:

• isDefaultVisibility()

isDefaultVisibility

public boolean isDefaultVisibility()

Returns:

true if visibility is default, false otherwise.

See Also:

• isDefaultModifier()

isPublic

public boolean isPublic()

Returns:

true if visibility is public, false otherwise.

isPrivate

public boolean isPrivate()

Returns:

true if visibility is private, false otherwise.

isProtected

public boolean isProtected()

Returns:

true if visibility is protected, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

formatModifiers

public void formatModifiers(Appendable buffer)

Parameters:

buffer - the Appendable where to append the Appendable.

of

public static CodeModifiers of(int javaModifiers)

Parameters:

javaModifiers - the Java Modifier mask.

Returns:

the given Modifier mask as CodeModifiers.

of

public static CodeModifiers of(int javaModifiers,
 boolean defaultMethod)

Parameters:

javaModifiers - the Java Modifier mask.

defaultMethod - - true for default method, false otherwise.

Returns:

the given Modifier mask as CodeModifiers.