程序包 cc.shacocloud.mirage.utils.annotation

类 AnnotationAttributes

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

cc.shacocloud.mirage.utils.annotation.AnnotationAttributes

所有已实现的接口:

Serializable, Cloneable, Map<String,Object>

public class AnnotationAttributes
extends LinkedHashMap<String,Object>

LinkedHashMap 子类，表示注释属性键值对

另请参阅:

序列化表格

嵌套类概要

从类继承的嵌套类/接口 java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

构造器概要

构造器

构造器	说明
AnnotationAttributes()	创建一个新的空 AnnotationAttributes 实例。
AnnotationAttributes(int initialCapacity)	创建一个新的空 AnnotationAttributes 实例，该实例具有给定的初始容量以优化性能。
AnnotationAttributes(@NotNull Class<? extends Annotation> annotationType)	为指定的 annotationType 创建一个新的空 AnnotationAttributes 实例。
AnnotationAttributes(AnnotationAttributes other)	复制一个新的 AnnotationAttributes 实例
AnnotationAttributes(Map<String,Object> map)	创建一个新的 AnnotationAttributes 实例，包装提供的映射及其所有键值对。

方法概要

修饰符和类型	方法	说明
@Nullable Class<? extends Annotation>	annotationType()	获取此 AnnotationAttributes 表示的注解类型。
static @Nullable AnnotationAttributes	fromMap(@Nullable Map<String,Object> map)	返回一个基于给定映射的 AnnotationAttributes 实例
AnnotationAttributes	getAnnotation(@NotNull String attributeName)	获取存储在指定 attributeName 下的 AnnotationAttributes。
<A extends Annotation> A	getAnnotation(@NotNull String attributeName, @NotNull Class<A> annotationType)	获取存储在指定 attributeName 下的类型 annotationType 的注释。
AnnotationAttributes[]	getAnnotationArray(@NotNull String attributeName)	获取存储在指定 attributeName 下的 AnnotationAttributes 数组。
<A extends Annotation> A[]	getAnnotationArray(@NotNull String attributeName, @NotNull Class<A> annotationType)	获取存储在指定 attributeName 下的 注释类型 的数组
boolean	getBoolean(@NotNull String attributeName)	获取存储在指定 attributeName 下的值作为布尔值
<T> Class<? extends T>	getClass(@NotNull String attributeName)	获取存储在指定 attributeName 下的值作为类
Class<?>[]	getClassArray(@NotNull String attributeName)	获取存储在指定 attributeName 下的值作为类数组
<E extends Enum<?>> E	getEnum(@NotNull String attributeName)	获取存储在指定 attributeName 下的值作为枚举
<N extends Number> N	getNumber(@NotNull String attributeName)	获取存储在指定 attributeName 下的值作为数字
<T> T	getRequiredAttribute(@NotNull String attributeName, @NotNull Class<T> expectedType)	获取存储在指定 attributeName 下的值，确保该值为 预期类型
String	getString(@NotNull String attributeName)	获取存储在指定 attributeName 下的值作为字符串
String[]	getStringArray(@NotNull String attributeName)	获取存储在指定 attributeName 下的值作为字符串数组
String	toString()

从类继承的方法 java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

从类继承的方法 java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

从类继承的方法 java.util.AbstractMap

equals, hashCode

从类继承的方法 java.lang.Object

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

从接口继承的方法 java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

构造器详细资料

AnnotationAttributes

public AnnotationAttributes()

创建一个新的空 AnnotationAttributes 实例。

AnnotationAttributes

public AnnotationAttributes(int initialCapacity)

创建一个新的空 AnnotationAttributes 实例，该实例具有给定的初始容量以优化性能。

参数:

initialCapacity - 基础地图的初始大小

AnnotationAttributes

public AnnotationAttributes(Map<String,Object> map)

创建一个新的 AnnotationAttributes 实例，包装提供的映射及其所有键值对。

另请参阅:

fromMap(Map)

AnnotationAttributes

public AnnotationAttributes(AnnotationAttributes other)

复制一个新的 AnnotationAttributes 实例

另请参阅:

fromMap(Map)

AnnotationAttributes

public AnnotationAttributes(@NotNull
                            @NotNull Class<? extends Annotation> annotationType)

为指定的 annotationType 创建一个新的空 AnnotationAttributes 实例。

方法详细资料

annotationType

@Nullable
public @Nullable Class<? extends Annotation> annotationType()

获取此 AnnotationAttributes 表示的注解类型。

返回:

注解类型，如果未知，则为 null

getString

public String getString(@NotNull
                        @NotNull String attributeName)

获取存储在指定 attributeName 下的值作为字符串

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getStringArray

public String[] getStringArray(@NotNull
                               @NotNull String attributeName)

获取存储在指定 attributeName 下的值作为字符串数组

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getBoolean

public boolean getBoolean(@NotNull
                          @NotNull String attributeName)

获取存储在指定 attributeName 下的值作为布尔值

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getNumber

public <N extends Number> N getNumber(@NotNull
                                      @NotNull String attributeName)

获取存储在指定 attributeName 下的值作为数字

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getEnum

public <E extends Enum<?>> E getEnum(@NotNull
                                     @NotNull String attributeName)

获取存储在指定 attributeName 下的值作为枚举

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getClass

public <T> Class<? extends T> getClass(@NotNull
                                       @NotNull String attributeName)

获取存储在指定 attributeName 下的值作为类

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getClassArray

public Class<?>[] getClassArray(@NotNull
                                @NotNull String attributeName)

获取存储在指定 attributeName 下的值作为类数组

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getAnnotation

public AnnotationAttributes getAnnotation(@NotNull
                                          @NotNull String attributeName)

获取存储在指定 attributeName 下的 AnnotationAttributes。

注意：如果你需要一个实际的注释，请调用getAnnotation(String, Class)。

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getAnnotation

public <A extends Annotation> A getAnnotation(@NotNull
                                              @NotNull String attributeName,
                                              @NotNull
                                              @NotNull Class<A> annotationType)

获取存储在指定 attributeName 下的类型 annotationType 的注释。

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getAnnotationArray

public AnnotationAttributes[] getAnnotationArray(@NotNull
                                                 @NotNull String attributeName)

获取存储在指定 attributeName 下的 AnnotationAttributes 数组。

如果存储在指定 attributeName 下的值是 AnnotationAttributes 的实例，则在返回之前，它将包装在单元素数组中。

注意：如果你需要一个实际的注解数组，请调用getAnnotationArray(String, Class)

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getAnnotationArray

public <A extends Annotation> A[] getAnnotationArray(@NotNull
                                                     @NotNull String attributeName,
                                                     @NotNull
                                                     @NotNull Class<A> annotationType)

获取存储在指定 attributeName 下的 注释类型 的数组

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

getRequiredAttribute

public <T> T getRequiredAttribute(@NotNull
                                  @NotNull String attributeName,
                                  @NotNull
                                  @NotNull Class<T> expectedType)

获取存储在指定 attributeName 下的值，确保该值为 预期类型

如果 expectType 是一个数组，并且存储在指定 attributeName 下的值是预期数组类型的组件类型的单个元素， 则单个元素将在返回之前包装在适当类型的单元素数组中。

抛出:

IllegalArgumentException - 如果属性不存在或不属于预期类型

toString

public String toString()

覆盖:

toString 在类中 AbstractMap<String,Object>

fromMap

@Nullable
public static @Nullable AnnotationAttributes fromMap(@Nullable
                                                     @Nullable Map<String,Object> map)

返回一个基于给定映射的 AnnotationAttributes 实例