Package io.swagger.models.properties

Class StringProperty

java.lang.Object

io.swagger.models.properties.AbstractProperty

io.swagger.models.properties.StringProperty

All Implemented Interfaces:

Property, Cloneable

Direct Known Subclasses:

ByteArrayProperty, EmailProperty

public class StringProperty
extends AbstractProperty
implements Property

The StringProperty class defines properties for strings without a specific format, for standard formats which don't need specific handling, or for custom formats.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringProperty.Format

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_default
protected List<String>	_enum
protected Integer	maxLength
protected Integer	minLength
protected String	pattern
static String	TYPE

Fields inherited from class io.swagger.models.properties.AbstractProperty

access, allowEmptyValue, booleanValue, description, example, format, name, position, readOnly, required, title, type, vendorExtensions, xml

Constructor Summary

Constructors

Constructor	Description
StringProperty()
StringProperty(StringProperty.Format format)
StringProperty(String format)

Method Summary

Modifier and Type	Method	Description
StringProperty	_default(String _default)
StringProperty	_enum(String value)
StringProperty	_enum(List<String> value)
boolean	equals(Object obj)
StringProperty	example(String example)
String	getDefault()
List<String>	getEnum()
Integer	getMaxLength()
Integer	getMinLength()
String	getPattern()
int	hashCode()
static boolean	isType(String type, String format)
StringProperty	maxLength(Integer maxLength)
StringProperty	minLength(Integer minLength)
StringProperty	pattern(String pattern)
StringProperty	readOnly()
StringProperty	required(boolean required)
void	setDefault(String _default)
void	setEnum(List<String> _enum)
void	setMaxLength(Integer maxLength)
void	setMinLength(Integer minLength)
void	setPattern(String pattern)
StringProperty	vendorExtension(String key, Object obj)
StringProperty	xml(Xml xml)

Methods inherited from class io.swagger.models.properties.AbstractProperty

allowEmptyValue, description, getAccess, getAllowEmptyValue, getBooleanValue, getDescription, getExample, getFormat, getName, getPosition, getReadOnly, getRequired, getTitle, getType, getVendorExtensions, getXml, rename, setAccess, setAllowEmptyValue, setBooleanValue, setDescription, setExample, setExample, setFormat, setName, setPosition, setReadOnly, setRequired, setTitle, setType, setVendorExtension, setVendorExtensionMap, setVendorExtensions, setXml, title

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.models.properties.Property

description, getAccess, getAllowEmptyValue, getBooleanValue, getDescription, getExample, getFormat, getName, getPosition, getReadOnly, getRequired, getTitle, getType, getVendorExtensions, getXml, rename, setAccess, setAllowEmptyValue, setBooleanValue, setDescription, setExample, setExample, setName, setPosition, setReadOnly, setRequired, setTitle, setXml, title

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

_enum

protected List<String> _enum

minLength

protected Integer minLength

maxLength

protected Integer maxLength

pattern

protected String pattern

_default

protected String _default

Constructor Detail

StringProperty

public StringProperty()

StringProperty

public StringProperty(StringProperty.Format format)

StringProperty

public StringProperty(String format)

Method Detail

isType

public static boolean isType(String type,
                             String format)

pattern

public StringProperty pattern(String pattern)

xml

public StringProperty xml(Xml xml)

example

public StringProperty example(String example)

minLength

public StringProperty minLength(Integer minLength)

maxLength

public StringProperty maxLength(Integer maxLength)

_enum

public StringProperty _enum(String value)

_enum

public StringProperty _enum(List<String> value)

_default

public StringProperty _default(String _default)

vendorExtension

public StringProperty vendorExtension(String key,
                                      Object obj)

required

public StringProperty required(boolean required)

readOnly

public StringProperty readOnly()

Overrides:

readOnly in class AbstractProperty

getEnum

public List<String> getEnum()

setEnum

public void setEnum(List<String> _enum)

getMinLength

public Integer getMinLength()

setMinLength

public void setMinLength(Integer minLength)

getMaxLength

public Integer getMaxLength()

setMaxLength

public void setMaxLength(Integer maxLength)

getPattern

public String getPattern()

setPattern

public void setPattern(String pattern)

getDefault

public String getDefault()

setDefault

public void setDefault(String _default)

Specified by:

setDefault in interface Property

Overrides:

setDefault in class AbstractProperty

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractProperty