Package org.graylog2.shared.rest.documentation.generator

Class Generator.Parameter

java.lang.Object

org.graylog2.shared.rest.documentation.generator.Generator.Parameter

Enclosing class:

Generator

public static class Generator.Parameter
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Generator.Parameter.Kind

Constructor Summary

Constructors

Constructor	Description
Parameter()

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()
org.graylog2.shared.rest.documentation.generator.Generator.TypeSchema	getTypeSchema()
Map<String,Object>	jsonValue()
void	setAllowableValues(Collection<String> allowableValues)
void	setDefaultValue(String defaultValue)
void	setDescription(String description)
void	setIsRequired(boolean required)
void	setKind(Generator.Parameter.Kind kind)
void	setName(String name)
void	setRequired(boolean required)
void	setTypeSchema(org.graylog2.shared.rest.documentation.generator.Generator.TypeSchema typeSchema)

Methods inherited from class java.lang.Object

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

Constructor Details

Parameter

public Parameter()

Method Details

setName

public void setName(String name)

setDescription

public void setDescription(String description)

setIsRequired

public void setIsRequired(boolean required)

setRequired

public void setRequired(boolean required)

setTypeSchema

public void setTypeSchema(org.graylog2.shared.rest.documentation.generator.Generator.TypeSchema typeSchema)

getTypeSchema

public org.graylog2.shared.rest.documentation.generator.Generator.TypeSchema getTypeSchema()

setKind

public void setKind(Generator.Parameter.Kind kind)

getDefaultValue

public String getDefaultValue()

setDefaultValue

public void setDefaultValue(String defaultValue)

setAllowableValues

public void setAllowableValues(Collection<String> allowableValues)

jsonValue

public Map<String,Object> jsonValue()