com.atlassian.clover.registry.entities

Class Modifiers

java.lang.Object

com.atlassian.clover.registry.entities.Modifiers

All Implemented Interfaces:

ModifiersInfo, TaggedPersistent

public class Modifiers
extends Object
implements TaggedPersistent, ModifiersInfo

container class for modifiers and annotations

Constructor Summary

Constructors

Constructor and Description
Modifiers()
Modifiers(ModifiersInfo modifiers)

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(AnnotationImpl annotation)
void	clearAnnotations()
boolean	containsAnnotation(Pattern pattern)
boolean	containsAnnotation(String... annotationNames) Returns true if the element is annotated with any of the specified annotations.
boolean	containsAnnotation(String name)
static Modifiers	createFrom(long modifiers, AnnotationImpl[] annotations)
Collection<Annotation>	getAnnotation(String name) Returns one (or more - introduced in Java 8) annotations with a given name.
Map<String,Collection<Annotation>>	getAnnotations() Returns a multi-map of all annotations - one key (annotation name) may contain mutliple values (i.e.
long	getMask()
String	getVisibility()
static Modifiers	read(TaggedDataInput in)
void	setMask(long mask)
String	toString()
void	write(TaggedDataOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Modifiers

public Modifiers()

Modifiers

public Modifiers(@Nullable
                 ModifiersInfo modifiers)

Method Detail

createFrom

public static Modifiers createFrom(long modifiers,
                                   @Nullable
                                   AnnotationImpl[] annotations)

containsAnnotation

public boolean containsAnnotation(@NotNull
                                  String name)

containsAnnotation

public boolean containsAnnotation(@NotNull
                                  Pattern pattern)

containsAnnotation

public boolean containsAnnotation(@NotNull
                                  String... annotationNames)

Returns true if the element is annotated with any of the specified annotations.

getAnnotation

@NotNull
public Collection<Annotation> getAnnotation(@NotNull
                                                     String name)

Description copied from interface: ModifiersInfo

Returns one (or more - introduced in Java 8) annotations with a given name.

Specified by:

getAnnotation in interface ModifiersInfo

Parameters:

name - name of the annotation to search

Returns:

Collection<Annotation> list of annotations with that name or empty list if not found

getAnnotations

@NotNull
public Map<String,Collection<Annotation>> getAnnotations()

Description copied from interface: ModifiersInfo

Returns a multi-map of all annotations - one key (annotation name) may contain mutliple values (i.e. multiple occurrences of the annotation, usually with different attributes)

Specified by:

getAnnotations in interface ModifiersInfo

Returns:

Map<String, Collection<Annotation>> - map(name, annotations)

addAnnotation

public void addAnnotation(AnnotationImpl annotation)

clearAnnotations

public void clearAnnotations()

setMask

public void setMask(long mask)

getMask

public long getMask()

Specified by:

getMask in interface ModifiersInfo

getVisibility

public String getVisibility()

write

public void write(TaggedDataOutput out)
           throws IOException

Specified by:

write in interface TaggedPersistent

Throws:

IOException

read

public static Modifiers read(TaggedDataInput in)
                      throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object