ComponentMetadata (Flow code generator API 2.0.18 API)

java.lang.Object
- com.vaadin.generator.metadata.ComponentMetadata

```
public class ComponentMetadata
extends Object
```
Base class of the representation of a webcomponent for the code generator. It holds all the data needed to generate the Java wrapper class that interacts with the webcomponent at the client side.

Since:

1.0

Constructor Summary

Constructors
Constructor and Description

ComponentMetadata()

Constructors
Constructor and Description
`ComponentMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBaseUrl()` Gets the baseUrl of the web component, which is the path to the WebComponent file.
`List<String>`	`getBehaviors()` Gets the list of behaviors a webcomponent can have.
`String`	`getDescription()` Gets the public description of the webcomponent, that can be used to generate the corresponding Javadoc at the Java class.
`List<ComponentEventData>`	`getEvents()` Gets the list of events triggered by the webcomponent, that can be intercepted at the server side by the corresponding Java class.
`List<ComponentFunctionData>`	`getMethods()` Gets the list of exposed methods of the webcomponent, that can be called from the corresponding Java class.
`List<String>`	`getMixins()` Gets the mixins of this web component.
`String`	`getName()` Gets the name of the ES6 class of the webcomponent, which is used to create the corresponding Java class.
`String`	`getParentTagName()` Gets parent element tag name or `null`, if no parents present.
`List<ComponentPropertyData>`	`getProperties()` Gets the `List` of properties exposed by the webcomponent.
`List<String>`	`getSlots()` Gets the slots of this web component.
`String`	`getTag()` Gets the tag name used by the webcomponent.
`Map<String,List<String>>`	`getVariants()` Gets theme variants for the component.
`String`	`getVersion()` Gets the version of the webcomponent.
`void`	`setBaseUrl(String baseUrl)` Sets the baseUrl of the web component, which is the path to the WebComponent file.
`void`	`setBehaviors(List<String> behaviors)` Sets the list of behaviors a webcomponent can have.
`void`	`setDescription(String description)` Sets the public description of the webcomponent, that can be used to generate the corresponding Javadoc at the Java class.
`void`	`setEvents(List<ComponentEventData> events)` Sets the list of events triggered by the webcomponent, that can be intercepted at the server side by the corresponding Java class.
`void`	`setMethods(List<ComponentFunctionData> methods)` Sets the list of exposed methods of the webcomponent, that can be called from the corresponding Java class.
`void`	`setMixins(List<String> mixins)` Sets the mixins for this web component.
`void`	`setName(String name)` Sets the name of the ES6 class of the webcomponent, which is used to create the corresponding Java class.
`void`	`setParentTagName(String parentTagName)` Sets parent element tag name, that is used to determine inheritance relations.
`void`	`setProperties(List<ComponentPropertyData> properties)` Sets the `List` of properties exposed by the webcomponent.
`void`	`setSlots(List<String> slots)` Sets the slots for this web component.
`void`	`setTag(String tag)` Sets the tag name used by the webcomponent.
`void`	`setVariants(Map<String,List<String>> variants)` Sets theme variants for the component.
`void`	`setVersion(String version)` Sets the version of the webcomponent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ComponentMetadata
```
public ComponentMetadata()
```
- Method Detail
  - getName
```
public String getName()
```
    Gets the name of the ES6 class of the webcomponent, which is used to create the corresponding Java class.
    
    Returns:
    
    The name of the of the webcomponent.
  - setName
```
public void setName(String name)
```
    Sets the name of the ES6 class of the webcomponent, which is used to create the corresponding Java class.
    
    Parameters:
    
    name - The name of the of the webcomponent.
  - getTag
```
public String getTag()
```
    Gets the tag name used by the webcomponent. For example "my-component", which is used at the HTML page as "<my-component>".
    
    Returns:
    
    The tag name of the webcomponent.
  - setTag
```
public void setTag(String tag)
```
    Sets the tag name used by the webcomponent. For example "my-component", which is used at the HTML page as "<my-component>".
    
    Parameters:
    
    tag - The tag name of the webcomponent.
  - getProperties
```
public List<ComponentPropertyData> getProperties()
```
    Gets the List of properties exposed by the webcomponent. Each individual property is represented by the ComponentPropertyData object.
    
    Returns:
    
    The list of exposed properties.
  - setProperties
```
public void setProperties(List<ComponentPropertyData> properties)
```
    Sets the List of properties exposed by the webcomponent. Each individual property is represented by the ComponentPropertyData object.
    
    Parameters:
    
    properties - The list of exposed properties.
  - getBehaviors
```
public List<String> getBehaviors()
```
    Gets the list of behaviors a webcomponent can have. A behavior can trigger different code generation workflows. For example, the behavior "container" makes the corresponding Java class accept child components, by implementing the HasComponents interface.
    
    Returns:
    
    The list of behaviors of the webcomponent.
  - setBehaviors
```
public void setBehaviors(List<String> behaviors)
```
    Sets the list of behaviors a webcomponent can have. A behavior can trigger different code generation workflows. For example, the behavior "container" makes the corresponding Java class accept child components, by implementing the HasComponents interface.
    
    Parameters:
    
    behaviors - The list of behaviors of the webcomponent.
  - getVersion
```
public String getVersion()
```
    Gets the version of the webcomponent.
    
    Returns:
    
    The version.
  - setVersion
```
public void setVersion(String version)
```
    Sets the version of the webcomponent.
    
    Parameters:
    
    version - The version of the webcomponent.
  - getDescription
```
public String getDescription()
```
    Gets the public description of the webcomponent, that can be used to generate the corresponding Javadoc at the Java class.
    
    Returns:
    
    The class-level description of the webcomponent.
  - setDescription
```
public void setDescription(String description)
```
    Sets the public description of the webcomponent, that can be used to generate the corresponding Javadoc at the Java class.
    
    Parameters:
    
    description - The class-level description of the webcomponent.
  - getParentTagName
```
public String getParentTagName()
```
    Gets parent element tag name or null, if no parents present.
    
    Returns:
    
    parent element tag name or null, if no parents present.
  - setParentTagName
```
public void setParentTagName(String parentTagName)
```
    Sets parent element tag name, that is used to determine inheritance relations.
    
    Parameters:
    
    parentTagName - parent element tag name
  - getMethods
```
public List<ComponentFunctionData> getMethods()
```
    Gets the list of exposed methods of the webcomponent, that can be called from the corresponding Java class. Each function is represented by the ComponentFunctionData object.
    
    Returns:
    
    The list of exposed methods.
  - setMethods
```
public void setMethods(List<ComponentFunctionData> methods)
```
    Sets the list of exposed methods of the webcomponent, that can be called from the corresponding Java class. Each function is represented by the ComponentFunctionData object.
    
    Parameters:
    
    methods - The list of exposed methods.
  - getEvents
```
public List<ComponentEventData> getEvents()
```
    Gets the list of events triggered by the webcomponent, that can be intercepted at the server side by the corresponding Java class. Each event is represented by the ComponentEventData object.
    
    Returns:
    
    The list of events.
  - setEvents
```
public void setEvents(List<ComponentEventData> events)
```
    Sets the list of events triggered by the webcomponent, that can be intercepted at the server side by the corresponding Java class. Each event is represented by the ComponentEventData object.
    
    Parameters:
    
    events - The list of events.
  - getBaseUrl
```
public String getBaseUrl()
```
    Gets the baseUrl of the web component, which is the path to the WebComponent file.
    E.g. "paper-input/paper-input.html"
    
    Returns:
    
    the baseUrl of the web component source file
  - setBaseUrl
```
public void setBaseUrl(String baseUrl)
```
    Sets the baseUrl of the web component, which is the path to the WebComponent file.
    E.g. "paper-input/paper-input.html"
    
    Parameters:
    
    baseUrl - the base url to set
  - getSlots
```
public List<String> getSlots()
```
    Gets the slots of this web component.
    Note that the empty string stands for the default slot that has no name. An empty list means that there are no slots.
    
    Returns:
    
    a list of the names of the slots
  - setSlots
```
public void setSlots(List<String> slots)
```
    Sets the slots for this web component.
    Note that the empty string stands for the default slot that has no name.
    
    Parameters:
    
    slots - list of the slot names
  - getMixins
```
public List<String> getMixins()
```
    Gets the mixins of this web component.
    
    Returns:
    
    a list of the mixin identifiers declared for this web component
  - setMixins
```
public void setMixins(List<String> mixins)
```
    Sets the mixins for this web component.
    
    Parameters:
    
    mixins - a list of mixin identifiers declared for this web component
  - getVariants
```
public Map<String,List<String>> getVariants()
```
    Gets theme variants for the component.
    
    Returns:
    
    theme variants data for the component
  - setVariants
```
public void setVariants(Map<String,List<String>> variants)
```
    Sets theme variants for the component.
    
    Parameters:
    
    variants - theme variants data for the component

Class ComponentMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComponentMetadata

Method Detail

getName

setName

getTag

setTag

getProperties

setProperties

getBehaviors

setBehaviors

getVersion

setVersion

getDescription

setDescription

getParentTagName

setParentTagName

getMethods

setMethods

getEvents

setEvents

getBaseUrl

setBaseUrl

getSlots

setSlots

getMixins

setMixins

getVariants

setVariants