org.apache.nifi.minifi.commons.schema.common

Class BaseSchema

java.lang.Object

org.apache.nifi.minifi.commons.schema.common.BaseSchema

Direct Known Subclasses:

ComponentStatusRepositorySchema, ConfigSchema, ConnectionSchema, ContentRepositorySchema, CorePropertiesSchema, FlowControllerSchema, FlowFileRepositorySchema, ProcessorSchema, ProvenanceReportingSchema, ProvenanceRepositorySchema, RemoteInputPortSchema, RemoteProcessingGroupSchema, SecurityPropertiesSchema, SensitivePropsSchema, SwapSchema

public abstract class BaseSchema
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	IT_WAS_NOT_FOUND_AND_IT_IS_REQUIRED
protected java.util.function.Supplier<Map<String,Object>>	mapSupplier
List<String>	validationIssues Validation Issue helper methods

Constructor Summary

Constructors

Constructor and Description
BaseSchema()
BaseSchema(java.util.function.Supplier<Map<String,Object>> mapSupplier)

Method Summary

Modifier and Type	Method and Description
void	addIssuesIfNotNull(BaseSchema baseSchema)
void	addValidationIssue(String keyName, String wrapperName, String reason)
<T> T	getAndValidate(java.util.function.Supplier<T> supplier, java.util.function.Predicate<T> predicate, String keyName, String wrapperName, String reason)
<T> T	getAndValidateNotNull(java.util.function.Supplier<T> supplier, String keyName, String wrapperName)
(package private) <T> T	getKeyAsType(Map valueMap, String key, Class<T> targetClass, String wrapperName, boolean required, T defaultValue)
<T> T	getMapAsType(Map valueMap, String key, Class<T> targetClass, String wrapperName, boolean required)
<T> T	getMapAsType(Map valueMap, String key, Class targetClass, String wrapperName, boolean required, boolean instantiateIfNull)
<T> T	getOptionalKeyAsType(Map valueMap, String key, Class<T> targetClass, String wrapperName, T defaultValue) Value Access/Interpretation helper methods
<T> T	getRequiredKeyAsType(Map valueMap, String key, Class<T> targetClass, String wrapperName)
List<String>	getValidationIssues()
String	getValidationIssuesAsString()
private <T> T	interpretValueAsType(Object obj, String key, Class targetClass, String wrapperName, boolean required, boolean instantiateIfNull)
boolean	isValid()
static <T> List<T>	nullToEmpty(List<T> list)
static <K,V> Map<K,V>	nullToEmpty(Map<K,V> map)
static <T> Set<T>	nullToEmpty(Set<T> set)
static void	putIfNotNull(Map valueMap, String key, BaseSchema schema)
static void	putListIfNotNull(Map valueMap, String key, List<? extends BaseSchema> list)
abstract Map<String,Object>	toMap()
<T> void	transformListToType(List<T> list, String simpleListType, Class<T> targetClass, String wrapperName)

Methods inherited from class java.lang.Object

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

Field Detail

IT_WAS_NOT_FOUND_AND_IT_IS_REQUIRED

public static final String IT_WAS_NOT_FOUND_AND_IT_IS_REQUIRED

See Also:

Constant Field Values

mapSupplier

protected final java.util.function.Supplier<Map<String,Object>> mapSupplier

validationIssues

public List<String> validationIssues

Validation Issue helper methods

Constructor Detail

BaseSchema

public BaseSchema()

BaseSchema

public BaseSchema(java.util.function.Supplier<Map<String,Object>> mapSupplier)

Method Detail

isValid

public boolean isValid()

getValidationIssues

public List<String> getValidationIssues()

getValidationIssuesAsString

public String getValidationIssuesAsString()

getAndValidateNotNull

public <T> T getAndValidateNotNull(java.util.function.Supplier<T> supplier,
                                   String keyName,
                                   String wrapperName)

getAndValidate

public <T> T getAndValidate(java.util.function.Supplier<T> supplier,
                            java.util.function.Predicate<T> predicate,
                            String keyName,
                            String wrapperName,
                            String reason)

addValidationIssue

public void addValidationIssue(String keyName,
                               String wrapperName,
                               String reason)

addIssuesIfNotNull

public void addIssuesIfNotNull(BaseSchema baseSchema)

getOptionalKeyAsType

public <T> T getOptionalKeyAsType(Map valueMap,
                                  String key,
                                  Class<T> targetClass,
                                  String wrapperName,
                                  T defaultValue)

Value Access/Interpretation helper methods

getRequiredKeyAsType

public <T> T getRequiredKeyAsType(Map valueMap,
                                  String key,
                                  Class<T> targetClass,
                                  String wrapperName)

getKeyAsType

<T> T getKeyAsType(Map valueMap,
                   String key,
                   Class<T> targetClass,
                   String wrapperName,
                   boolean required,
                   T defaultValue)

getMapAsType

public <T> T getMapAsType(Map valueMap,
                          String key,
                          Class<T> targetClass,
                          String wrapperName,
                          boolean required)

getMapAsType

public <T> T getMapAsType(Map valueMap,
                          String key,
                          Class targetClass,
                          String wrapperName,
                          boolean required,
                          boolean instantiateIfNull)

transformListToType

public <T> void transformListToType(List<T> list,
                                    String simpleListType,
                                    Class<T> targetClass,
                                    String wrapperName)

interpretValueAsType

private <T> T interpretValueAsType(Object obj,
                                   String key,
                                   Class targetClass,
                                   String wrapperName,
                                   boolean required,
                                   boolean instantiateIfNull)

toMap

public abstract Map<String,Object> toMap()

putIfNotNull

public static void putIfNotNull(Map valueMap,
                                String key,
                                BaseSchema schema)

putListIfNotNull

public static void putListIfNotNull(Map valueMap,
                                    String key,
                                    List<? extends BaseSchema> list)

nullToEmpty

public static <T> List<T> nullToEmpty(List<T> list)

nullToEmpty

public static <T> Set<T> nullToEmpty(Set<T> set)

nullToEmpty

public static <K,V> Map<K,V> nullToEmpty(Map<K,V> map)