cn.hutool.core.annotation

Enum RelationType

java.lang.Object

java.lang.Enum<RelationType>

cn.hutool.core.annotation.RelationType

All Implemented Interfaces:

Serializable, Comparable<RelationType>

public enum RelationType
extends Enum<RelationType>

注解属性的关系类型
若将被Link注解的属性称为“原始属性”，而在Link注解中指向的注解属性称为“关联属性”， 则该枚举用于描述“原始属性”与“关联属性”在SynthesizedAggregateAnnotation处理过程中的作用关系。
根据在Link.type()中指定的关系类型的不同，通过SynthesizedAggregateAnnotation合成的注解的属性值也将有所变化。

当一个注解中的所有属性同时具备多种关系时，将依次按下述顺序处理：

1. 属性上的Alias注解；
2. 属性上的Link注解，且Link.type()为MIRROR_FOR；
3. 属性上的Link注解，且Link.type()为FORCE_ALIAS_FOR；
4. 属性上的Link注解，且Link.type()为ALIAS_FOR；

Author:

huangchengxing

See Also:

SynthesizedAggregateAnnotation, Link

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALIAS_FOR 表示“原始属性”将作为“关联属性”的别名。
FORCE_ALIAS_FOR 表示“原始属性”将强制作为“关联属性”的别名。
MIRROR_FOR 表示注解的属性与指定的属性互为镜像，通过一个属性将能够获得对方的值。

Method Summary

Modifier and Type	Method and Description
static RelationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RelationType[]	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

MIRROR_FOR

public static final RelationType MIRROR_FOR

表示注解的属性与指定的属性互为镜像，通过一个属性将能够获得对方的值。
它们遵循下述规则：

• 互为镜像的两个属性，必须同时通过指定模式为MIRROR_FOR的Link注解指定对方；
• 互为镜像的两个属性，类型必须一致；
• 互为镜像的两个属性在获取值，且两者的值皆不同时，必须且仅允许有一个非默认值，该值被优先返回；
• 互为镜像的两个属性，在值都为默认值或都不为默认值时，两者的值必须相等；

ALIAS_FOR

public static final RelationType ALIAS_FOR

表示“原始属性”将作为“关联属性”的别名。

• 当“原始属性”为默认值时，获取“关联属性”将返回“关联属性”本身的值；
• 当“原始属性”不为默认值时，获取“关联属性”将返回“原始属性”的值；

FORCE_ALIAS_FOR

public static final RelationType FORCE_ALIAS_FOR

表示“原始属性”将强制作为“关联属性”的别名。效果等同于在“原始属性”上添加Alias注解， 任何情况下，获取“关联属性”的值都将直接返回“原始属性”的值

Method Detail

values

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

Returns:

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

valueOf

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