Index (Flow code generator API 2.0.17 API)

A B C E F G I N P S T V W

A

addMethodParameter(JavaClassSource, MethodSource<JavaClassSource>, Class<?>, String) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Adds a parameter with the specified type and name to the given method, considering simple name for java.lang package.

B

BehaviorRegistry - Class in com.vaadin.generator.registry: Registry that maps behaviors and mixins from the client side to interfaces at the server-side.
build() - Method in class com.vaadin.generator.ComponentGenerator: Generate the class according to the set values.
build() - Method in class com.vaadin.generator.NestedClassGenerator: Builds the Java class by using the defined settings.

C

com.vaadin.generator - package com.vaadin.generator
com.vaadin.generator.exception - package com.vaadin.generator.exception
com.vaadin.generator.metadata - package com.vaadin.generator.metadata
com.vaadin.generator.registry - package com.vaadin.generator.registry
ComponentBasicType - Enum in com.vaadin.generator.metadata: Supported types that are read from the webcomponent and translated to Java types.
ComponentEventData - Class in com.vaadin.generator.metadata: Represents an event the webcomponent can trigger.
ComponentEventData() - Constructor for class com.vaadin.generator.metadata.ComponentEventData
ComponentFunctionData - Class in com.vaadin.generator.metadata: Represents a exposed function of the webcomponent, that can be called on the server-side by the corresponding Java class.
ComponentFunctionData() - Constructor for class com.vaadin.generator.metadata.ComponentFunctionData
ComponentFunctionParameterData - Class in com.vaadin.generator.metadata: Represents a parameter of a exposed function of the webcomponent.
ComponentFunctionParameterData() - Constructor for class com.vaadin.generator.metadata.ComponentFunctionParameterData
ComponentGenerationException - Exception in com.vaadin.generator.exception: Runtime exception for errors on the code generation process.
ComponentGenerationException(String) - Constructor for exception com.vaadin.generator.exception.ComponentGenerationException: Constructs the exception with a message.
ComponentGenerationException(String, Throwable) - Constructor for exception com.vaadin.generator.exception.ComponentGenerationException: Constructs the exception with a message and a cause.
ComponentGenerator - Class in com.vaadin.generator: Base class of the component generation process.
ComponentGenerator() - Constructor for class com.vaadin.generator.ComponentGenerator
ComponentGeneratorUtils - Class in com.vaadin.generator: Utility methods for the code generation process.
ComponentMetadata - Class in com.vaadin.generator.metadata: Base class of the representation of a webcomponent for the code generator.
ComponentMetadata() - Constructor for class com.vaadin.generator.metadata.ComponentMetadata
ComponentObjectType - Class in com.vaadin.generator.metadata: Represents a webcomponent's property / method parameter of type object.
ComponentObjectType() - Constructor for class com.vaadin.generator.metadata.ComponentObjectType
ComponentObjectType.ComponentObjectTypeInnerType - Class in com.vaadin.generator.metadata: Holds the list of actual types in a ComponentObjectType.
ComponentObjectTypeInnerType() - Constructor for class com.vaadin.generator.metadata.ComponentObjectType.ComponentObjectTypeInnerType
ComponentPropertyBaseData - Class in com.vaadin.generator.metadata: Base class of properties exposed by the webcomponent, that can be properties themselves, event properties or function parameters.
ComponentPropertyBaseData() - Constructor for class com.vaadin.generator.metadata.ComponentPropertyBaseData
ComponentPropertyData - Class in com.vaadin.generator.metadata: Represents a property exposed by the webcomponent.
ComponentPropertyData() - Constructor for class com.vaadin.generator.metadata.ComponentPropertyData
ComponentType - Interface in com.vaadin.generator.metadata: Marker interface for component types.
convertCamelCaseToHyphens(String) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Converts a string in camel-case to a lower case string where each term is separated by an hyphen.
convertFilePathToPackage(String) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Generates a package name based on a file path structure.
convertPackageToDirectory(File, String, boolean) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Generates the directory structure based on a package name.

E

excludeBehaviorOrMixin(String, String) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Excludes a behavior or mixin from being evaluated for a specific element denoted by its tag.
excludeEvent(String, String) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Excludes an event from being generated for a specific element denoted by its tag.
excludeInterface(String, Class<?>) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Excludes an interface from being evaluated for a specific element denoted by its tag.
excludeMethod(String, String) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Excludes a method from being generated for a specific element denoted by its tag.
excludeProperty(String, String) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Excludes a property from being generated for a specific element denoted by its tag.
excludePropertyType(ComponentBasicType) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Excludes all the properties that have the given type from all the components.
excludeTag(String) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Excludes the element generation denoted by its tag.
ExclusionRegistry - Class in com.vaadin.generator.registry: Registry for all exclusions in the generated files.

F

formatStringToJavaComment(String) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Formats and ordinary String as a multi-line Java comment, that can be safely added to any part of a Java code.
formatStringToValidJavaIdentifier(String) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Same as calling ComponentGeneratorUtils.formatStringToValidJavaIdentifier(String, boolean) with false - not ignoring Java reserved words.
formatStringToValidJavaIdentifier(String, boolean) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Formats a given name (which can be a property name, function name or event name) to a valid Java identifier.
FunctionParameterVariantCombinator - Class in com.vaadin.generator: Utility class for generating all possible combinations of allowed parameters for ComponentFunctionData.

G

generateClass(File, File, String, String) - Method in class com.vaadin.generator.ComponentGenerator: Generates the Java class by reading the webcomponent metadata from a JSON file.
generateClass(ComponentMetadata, String, String) - Method in class com.vaadin.generator.ComponentGenerator: Generates and returns the Java class based on the ComponentMetadata.
generateClass(File, String, String) - Method in class com.vaadin.generator.ComponentGenerator: Generates and returns the Java class based on the JSON file provide.
generateClass(ComponentMetadata, File, String, String) - Method in class com.vaadin.generator.ComponentGenerator: Generates the Java class by using the ComponentMetadata object.
generateElementApiGetterForType(ComponentBasicType, String) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Generates a code snippet that uses the Element API to retrieve properties from the client model.
generateElementApiSetterForType(ComponentBasicType, String, String, boolean) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Generates a code snippet that uses the Element API to set properties to the client model.
generateElementApiValueGetterForType(ComponentBasicType, String) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Generates a code snippet that uses the Element API to retrieve properties from the client model when it implements the HasValue contract.
generateMethodNameForProperty(String, String) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Formats property name to valid java identifier with CamelCase
generateValidJavaClassName(String) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Creates a valid Java class name based on the ES6 class name.
generateVariants(ComponentFunctionData) - Static method in class com.vaadin.generator.FunctionParameterVariantCombinator: Utility method for generating all possible combinations of allowed parameters for ComponentFunctionData.
getBaseUrl() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the baseUrl of the web component, which is the path to the WebComponent file.
getBehaviors() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the list of behaviors a webcomponent can have.
getClassesForBehaviors(Iterable<String>) - Static method in class com.vaadin.generator.registry.BehaviorRegistry: Gets the interfaces to be inherited by the generated Java class, based on the list of behaviors and mixins that the original webcomponent contains.
getDescription() - Method in class com.vaadin.generator.metadata.ComponentEventData: Gets the public description of the event, that can be used to generate the corresponding Javadoc at the Java class.
getDescription() - Method in class com.vaadin.generator.metadata.ComponentFunctionData: Gets the public description of the function, that can be used to generate the corresponding Javadoc at the Java class.
getDescription() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the public description of the webcomponent, that can be used to generate the corresponding Javadoc at the Java class.
getDescription() - Method in class com.vaadin.generator.metadata.ComponentPropertyBaseData: Gets the public description of the function parameter, that can be used to generate the corresponding Javadoc at the Java class.
getEvents() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the list of events triggered by the webcomponent, that can be intercepted at the server side by the corresponding Java class.
getInnerTypes() - Method in class com.vaadin.generator.metadata.ComponentObjectType: Get the list of actual types contained in this ComponentObjectType.
getMethods() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the list of exposed methods of the webcomponent, that can be called from the corresponding Java class.
getMixins() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the mixins of this web component.
getName() - Method in class com.vaadin.generator.metadata.ComponentEventData: Gets the name of the event, such as "click".
getName() - Method in class com.vaadin.generator.metadata.ComponentFunctionData: Gets the name of the function on the webcomponent.
getName() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the name of the ES6 class of the webcomponent, which is used to create the corresponding Java class.
getName() - Method in class com.vaadin.generator.metadata.ComponentObjectType.ComponentObjectTypeInnerType: Gets the name of the property.
getName() - Method in class com.vaadin.generator.metadata.ComponentPropertyBaseData: Gets the name of the property.
getObjectType() - Method in class com.vaadin.generator.metadata.ComponentPropertyBaseData: Gets the object type properties.
getOptionalMappingFor(String, String) - Static method in class com.vaadin.generator.registry.PropertyNameRemapRegistry: Look for a property name remapping for the given element in this registry.
getParameters() - Method in class com.vaadin.generator.metadata.ComponentFunctionData: Gets the list of parameters of the function.
getParentTagName() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets parent element tag name or null, if no parents present.
getProperties() - Method in class com.vaadin.generator.metadata.ComponentEventData: Gets the list of properties that are part of the event.
getProperties() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the List of properties exposed by the webcomponent.
getReturns() - Method in class com.vaadin.generator.metadata.ComponentFunctionData: Gets the return type of the function.
getSlots() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the slots of this web component.
getTag() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the tag name used by the webcomponent.
getType() - Method in class com.vaadin.generator.metadata.ComponentObjectType.ComponentObjectTypeInnerType: Gets the type of the property.
getType() - Method in class com.vaadin.generator.metadata.ComponentPropertyBaseData: Gets the type of the property, or if property allows varying types, a list of those.
getVariants() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets theme variants for the component.
getVersion() - Method in class com.vaadin.generator.metadata.ComponentMetadata: Gets the version of the webcomponent.

I

isBasicType() - Method in interface com.vaadin.generator.metadata.ComponentType: Check whether this instance represents a basic type.
isBehaviorOrMixinExcluded(String, String) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Gets whether a behavior or mixin should be excluded or not from the generation.
isEventExcluded(String, String) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Gets whether an event should be excluded or not from the generation.
isInterfaceExcluded(String, Class<?>) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Gets whether an interface should be excluded or not from the generation.
isMethodExcluded(String, String) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Gets whether a method should be excluded or not from the generation.
isNotify() - Method in class com.vaadin.generator.metadata.ComponentPropertyData: Gets whether the webcomponent automatically fires a propertyName-changed event every time the property value changes on the client-side
isOptional() - Method in class com.vaadin.generator.metadata.ComponentFunctionParameterData: Gets whether the parameter is optional or not when calling the function.
isOptional() - Method in class com.vaadin.generator.metadata.ComponentObjectType.ComponentObjectTypeInnerType: Returns whether the this property is optional or not.
isPropertyExcluded(String, String, Set<ComponentBasicType>) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Gets whether a property should be excluded or not from the generation.
isReadOnly() - Method in class com.vaadin.generator.metadata.ComponentPropertyData: Gets whether the property is read-only or not.
isTagExcluded(String) - Static method in class com.vaadin.generator.registry.ExclusionRegistry: Gets whether an Element should be excluded or not from the generation.

N

NestedClassGenerator - Class in com.vaadin.generator: Nested POJOs Generator.
NestedClassGenerator() - Constructor for class com.vaadin.generator.NestedClassGenerator

P

PropertyNameRemapRegistry - Class in com.vaadin.generator.registry: Registry that facilitates remapping of element property names to different names for the generated components' java API.

S

setBaseUrl(String) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the baseUrl of the web component, which is the path to the WebComponent file.
setBehaviors(List<String>) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the list of behaviors a webcomponent can have.
setDescription(String) - Method in class com.vaadin.generator.metadata.ComponentEventData: Sets the public description of the event, that can be used to generate the corresponding Javadoc at the Java class.
setDescription(String) - Method in class com.vaadin.generator.metadata.ComponentFunctionData: Sets the public description of the function, that can be used to generate the corresponding Javadoc at the Java class.
setDescription(String) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the public description of the webcomponent, that can be used to generate the corresponding Javadoc at the Java class.
setDescription(String) - Method in class com.vaadin.generator.metadata.ComponentPropertyBaseData: Sets the public description of the function parameter, that can be used to generate the corresponding Javadoc at the Java class.
setEvents(List<ComponentEventData>) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the list of events triggered by the webcomponent, that can be intercepted at the server side by the corresponding Java class.
setInnerTypes(List<ComponentObjectType.ComponentObjectTypeInnerType>) - Method in class com.vaadin.generator.metadata.ComponentObjectType: Sets the list of actual types contained in this ComponentObjectType.
setMethods(List<ComponentFunctionData>) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the list of exposed methods of the webcomponent, that can be called from the corresponding Java class.
setMixins(List<String>) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the mixins for this web component.
setName(String) - Method in class com.vaadin.generator.metadata.ComponentEventData: Sets the name of the event, such as "click".
setName(String) - Method in class com.vaadin.generator.metadata.ComponentFunctionData: Sets the name of the function on the webcomponent.
setName(String) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the name of the ES6 class of the webcomponent, which is used to create the corresponding Java class.
setName(String) - Method in class com.vaadin.generator.metadata.ComponentObjectType.ComponentObjectTypeInnerType: Sets the name of the property.
setName(String) - Method in class com.vaadin.generator.metadata.ComponentPropertyBaseData: Sets the name of the property.
setNotify(boolean) - Method in class com.vaadin.generator.metadata.ComponentPropertyData: Sets whether the webcomponent automatically fires a propertyName-changed event everytime the property value changes on the client-side.
setObjectType(List<ComponentObjectType>) - Method in class com.vaadin.generator.metadata.ComponentPropertyBaseData: Sets the object type properties.
setOptional(boolean) - Method in class com.vaadin.generator.metadata.ComponentFunctionParameterData: Sets whether the parameter is optional or not when calling the function.
setOptional(boolean) - Method in class com.vaadin.generator.metadata.ComponentObjectType.ComponentObjectTypeInnerType: Set this property as optional or not.
setParameters(List<ComponentFunctionParameterData>) - Method in class com.vaadin.generator.metadata.ComponentFunctionData: Sets the list of parameters of the function.
setParentTagName(String) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets parent element tag name, that is used to determine inheritance relations.
setProperties(List<ComponentPropertyBaseData>) - Method in class com.vaadin.generator.metadata.ComponentEventData: Sets the list of properties that are part of the event.
setProperties(List<ComponentPropertyData>) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the List of properties exposed by the webcomponent.
setReadOnly(boolean) - Method in class com.vaadin.generator.metadata.ComponentPropertyData: Sets whether the property is read-only or not.
setReturns(ComponentBasicType) - Method in class com.vaadin.generator.metadata.ComponentFunctionData: Sets the return type of the function.
setSlots(List<String>) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the slots for this web component.
setTag(String) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the tag name used by the webcomponent.
setType(List<ComponentBasicType>) - Method in class com.vaadin.generator.metadata.ComponentObjectType.ComponentObjectTypeInnerType: Sets the type of the property.
setType(Set<ComponentBasicType>) - Method in class com.vaadin.generator.metadata.ComponentPropertyBaseData: Sets the type of the property, or if property allows varying types, a list of those.
setVariants(Map<String, List<String>>) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets theme variants for the component.
setVersion(String) - Method in class com.vaadin.generator.metadata.ComponentMetadata: Sets the version of the webcomponent.

T

toJavaType(ComponentBasicType) - Static method in class com.vaadin.generator.ComponentGeneratorUtils: Converts a javascript basic type to a Java type.
toMetadata(File) - Method in class com.vaadin.generator.ComponentGenerator: Converts the JSON file to ComponentMetadata.

V

valueName(String) - Static method in class com.vaadin.generator.registry.ValuePropertyRegistry: Returns the 'value' property name for a given tag.
valueOf(String) - Static method in enum com.vaadin.generator.metadata.ComponentBasicType: Returns the enum constant of this type with the specified name.
ValuePropertyRegistry - Class in com.vaadin.generator.registry: Registry that facilitates mapping which property name will be used when the element should extend AbstractField API.
values() - Static method in enum com.vaadin.generator.metadata.ComponentBasicType: Returns an array containing the constants of this enum type, in the order they are declared.

W

withAbstractClass(boolean) - Method in class com.vaadin.generator.ComponentGenerator: When set to true, the generated class will be marked as abstract.
withBasePackage(String) - Method in class com.vaadin.generator.ComponentGenerator: Set the base package that will be used.
withClassNamePrefix(String) - Method in class com.vaadin.generator.ComponentGenerator: Set a prefix for the name of all generated classes.
withFluentMethods(boolean) - Method in class com.vaadin.generator.ComponentGenerator: Set whether the generator should use fluent Methods - methods that return the own object so it's possible to use method chaining.
withFluentSetters(boolean) - Method in class com.vaadin.generator.NestedClassGenerator: Sets whether the generated POJO should contain fluent setters or not.
withFrontendDirectory(String) - Method in class com.vaadin.generator.ComponentGenerator: Set the import frontend base package.
withJsonFile(File) - Method in class com.vaadin.generator.ComponentGenerator: Set the input JSON file.
withLicenseNote(String) - Method in class com.vaadin.generator.ComponentGenerator: Set the license header notice for the file.
withNameHint(String) - Method in class com.vaadin.generator.NestedClassGenerator: Sets the name hint that will be used to generate the final name of the generated class.
withProtectedMethods(boolean) - Method in class com.vaadin.generator.ComponentGenerator: When set to true, all generated methods will be protected.
withTargetPath(File) - Method in class com.vaadin.generator.ComponentGenerator: Set the target output directory.
withType(ComponentObjectType) - Method in class com.vaadin.generator.NestedClassGenerator: Sets the ComponentObjectType this generator will use to create the getters and setters for the properties.

A B C E F G I N P S T V W