io.cdap.cdap.api.plugin

Class PluginPropertyField

java.lang.Object

io.cdap.cdap.api.plugin.PluginPropertyField

@Beta
public class PluginPropertyField
extends Object

Contains information about a property used by a plugin.

Constructor Summary

Constructors

Constructor and Description
PluginPropertyField(String name, String description, String type, boolean required, boolean macroSupported)
PluginPropertyField(String name, String description, String type, boolean required, boolean macroSupported, boolean macroEscapingEnabled)
PluginPropertyField(String name, String description, String type, boolean required, boolean macroSupported, boolean macroEscapingEnabled, Set<String> children)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Set<String>	getChildren() Returns the list of configs inside this property, empty if it does not contain any.
String	getDescription() Returns description for the property.
String	getName() Returns name of the property.
String	getType() Returns the type of the property.
int	hashCode()
boolean	isMacroEscapingEnabled() Returns true if the macro escaping is enabled, false otherwise.
boolean	isMacroSupported() Returns true if the property supports macro, false otherwise.
boolean	isRequired() Returns true if the property is required by the plugin, false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginPropertyField

public PluginPropertyField(String name,
                           String description,
                           String type,
                           boolean required,
                           boolean macroSupported,
                           boolean macroEscapingEnabled,
                           Set<String> children)

PluginPropertyField

public PluginPropertyField(String name,
                           String description,
                           String type,
                           boolean required,
                           boolean macroSupported)

PluginPropertyField

public PluginPropertyField(String name,
                           String description,
                           String type,
                           boolean required,
                           boolean macroSupported,
                           boolean macroEscapingEnabled)

Method Detail

getName

public String getName()

Returns name of the property.

getDescription

public String getDescription()

Returns description for the property.

isRequired

public boolean isRequired()

Returns true if the property is required by the plugin, false otherwise.

isMacroSupported

public boolean isMacroSupported()

Returns true if the property supports macro, false otherwise.

isMacroEscapingEnabled

public boolean isMacroEscapingEnabled()

Returns true if the macro escaping is enabled, false otherwise.

getChildren

public Set<String> getChildren()

Returns the list of configs inside this property, empty if it does not contain any.

getType

public String getType()

Returns the type of the property.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object