io.fabric8.crd.generator.annotation

Annotation Type SchemaSwap

@Target(value={ANNOTATION_TYPE,TYPE_USE,TYPE})
 @Retention(value=RUNTIME)
 @Repeatable(value=SchemaSwaps.class)
public @interface SchemaSwap

Annotation that allows replacing a nested schema with one from another class. This is an alternative to SchemaFrom for cases when the classes are coming from an external source and fields cannot be annotated directly.

See Also:

SchemaFrom

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	fieldName Name of the field whose type is to be replaced.
Class<?>	originalType The owning class of the field whose type is to be replaced.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	depth For fields that may include a reference cycle, how many expansions to include in the output before including the targetType()
Class<?>	targetType The replacement schema that will be used for the fieldName() instead of its specified type

Element Detail

originalType

public abstract Class<?> originalType

The owning class of the field whose type is to be replaced.

It is an error if the type is not used in the same schema hierarchy where the SchemaSwap is used.

fieldName

public abstract String fieldName

Name of the field whose type is to be replaced.

The name should be specified exactly as defined in the Java class, before any renames and transformations (@JsonProperty and similar) take place.

It is an error if the field does not exist on originalType()

targetType

public abstract Class<?> targetType

The replacement schema that will be used for the fieldName() instead of its specified type

The default value of void.class causes the field to be skipped

Default:

void.class

depth

public abstract int depth

For fields that may include a reference cycle, how many expansions to include in the output before including the targetType()

The default value of 0 replaces the field with the targetType() without any expansion

Default:

0