Package com.broadleafcommerce.metadata.dsl.core.extension.fields

Interface DerivedField<F extends DerivedField<F>>

All Superinterfaces:

Comparable<F>, Component<F>, Copyable<F>, Field<F>, FormComponent<F>, Serializable

All Known Implementing Classes:

DefaultDerivedField

public interface DerivedField<F extends DerivedField<F>>
extends Field<F>

Represents the metadata for a FieldTypes.DERIVED field component. The default type is "camel", which means the original value wil be transformed to came-case: camelCase. Use source(String), kebab(), or snake() to do a different transformation, or use none() to perform no transformation.

Author:

Jon Fleschler (jfleschler)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DerivedField.Attributes

Method Summary

Modifier and Type	Method	Description
default F	camel()	Indicates that the source value will be transformed to camel case: someValue.
default F	kebab()	Indicates that the source value will be transformed to kebab case: some-value.
default F	none()	Indicates that no transformation of the source will occur.
default F	snake()	Indicates that the source value will be transformed to snake case: some_value.
default F	source(String source)

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Component

addAction, addAction, addComponent, addEndpoint, addEndpoint, apply, attribute, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentationKey, getClassifier, getComponent, getComponent, getComponents, getComponentsList, getConditionals, getDescription, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOrder, getScope, getType, hasAction, hasAttribute, hasComponent, hasEndpoint, id, isAugmentable, isTranslatable, label, label, notTranslatable, order, removeAction, removeAttribute, removeComponent, removeEndpoint, scope, self, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, translatable, translatable, type

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Field

clearReadOnlyConditionals, decorated, defaultValue, getDefaultValue, getName, getPlaceholder, getReadOnlyConditionals, getRequiredMessage, getValidationSchema, isReadOnly, isRequired, isShowInQueryBuilder, isTargetCollection, name, notReadOnly, notRequired, placeholder, placeholder, readOnly, readOnly, readOnlyConditional, readOnlyConditionals, required, required, required, required, requiredMessage, requiredMessage, setDefaultValue, setName, setPlaceholder, setReadOnly, setReadOnlyConditionals, setRequired, setRequiredMessage, setShowInQueryBuilder, setValidationSchema, targetIsCollection, targetIsNotCollection, validationMethod, validationSchema, validationSchema

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.FormComponent

getHelpText, getHint, getTooltip, helpText, helpText, hidden, hidden, hint, hint, isHidden, notHidden, setHelpText, setHidden, setHint, setTooltip, tooltip, tooltip

Method Details

source

default F source(String source)

kebab

default F kebab()

Indicates that the source value will be transformed to kebab case: some-value.

camel

default F camel()

Indicates that the source value will be transformed to camel case: someValue.

This is the default value.

snake

default F snake()

Indicates that the source value will be transformed to snake case: some_value.

none

default F none()

Indicates that no transformation of the source will occur.