Package com.atlan.model.structs

Class FormField

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.structs.AtlanStruct

com.atlan.model.structs.FormField

All Implemented Interfaces:

Serializable

@Generated("com.atlan.generators.ModelGeneratorV2")
public class FormField
extends AtlanStruct

Structure of a field in a form.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormField.FormFieldBuilder<C extends FormField,B extends FormField.FormFieldBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.structs.AtlanStruct

AtlanStruct.AtlanStructBuilder<C extends AtlanStruct,B extends AtlanStruct.AtlanStructBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_NAME

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FormField(FormField.FormFieldBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static FormField.FormFieldBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
FormFieldDimension	getFormFieldDimension()	Dimension of the field's value in a form.
String	getFormFieldId()	Unique identifier of the field in a form.
String	getFormFieldName()	Name of the field in a form.
Map<String,String>	getFormFieldOptions()	Options of the field in a form.
FormFieldType	getFormFieldType()	Type of the field in a form.
String	getTypeName()	Fixed typeName for FormField.
int	hashCode()
static FormField	of(String formFieldId, String formFieldName, FormFieldType formFieldType, FormFieldDimension formFieldDimension, Map<String,String> formFieldOptions)	Quickly create a new FormField.
FormField.FormFieldBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TYPE_NAME

public static final String TYPE_NAME

See Also:

• Constant Field Values

Constructor Details

FormField

protected FormField(FormField.FormFieldBuilder<?,?> b)

Method Details

of

public static FormField of(String formFieldId,
 String formFieldName,
 FormFieldType formFieldType,
 FormFieldDimension formFieldDimension,
 Map<String,String> formFieldOptions)

Quickly create a new FormField.

Parameters:

formFieldId - Unique identifier of the field in a form.

formFieldName - Name of the field in a form.

formFieldType - Type of the field in a form.

formFieldDimension - Dimension of the field's value in a form.

formFieldOptions - Options of the field in a form.

Returns:

a FormField with the provided information

builder

public static FormField.FormFieldBuilder<?,?> builder()

toBuilder

public FormField.FormFieldBuilder<?,?> toBuilder()

getFormFieldId

public String getFormFieldId()

Unique identifier of the field in a form.

getFormFieldName

public String getFormFieldName()

Name of the field in a form.

getFormFieldType

public FormFieldType getFormFieldType()

Type of the field in a form.

getFormFieldDimension

public FormFieldDimension getFormFieldDimension()

Dimension of the field's value in a form.

getFormFieldOptions

public Map<String,String> getFormFieldOptions()

Options of the field in a form.

equals

public boolean equals(Object o)

Overrides:

equals in class AtlanStruct

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AtlanStruct

hashCode

public int hashCode()

Overrides:

hashCode in class AtlanStruct

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AtlanObject

getTypeName

public String getTypeName()

Fixed typeName for FormField.

Overrides:

getTypeName in class AtlanStruct