org.forgerock.api.transform

Class LocalizableRefProperty

java.lang.Object

io.swagger.models.properties.AbstractProperty

io.swagger.models.properties.RefProperty

org.forgerock.api.transform.LocalizableRefProperty

All Implemented Interfaces:

io.swagger.models.properties.Property, Cloneable

public class LocalizableRefProperty
extends io.swagger.models.properties.RefProperty

Localizable RefProperty.

Field Summary

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

TYPE

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

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

Constructor Summary

Constructors

Constructor and Description
LocalizableRefProperty() Creates a new LocalizableRefProperty.
LocalizableRefProperty(String ref) Creates a new LocalizableRefProperty with the given JSON Reference.

Method Summary

Modifier and Type	Method and Description
LocalizableRefProperty	description(LocalizableString description) Set the localizable description.
LocalizableRefProperty	description(String description) Set the plain string description.
String	getDescription()
LocalizableString	getLocalizableDescription() Get the localizable title for Jackson.
LocalizableString	getLocalizableTitle() Get the localizable title for Jackson.
String	getTitle()
void	setDescription(String description)
void	setFormat(String format) Pull method from AbstractProperty into this interface.
void	setTitle(String title)
void	setVendorExtension(String name, Object value) Pull method from AbstractProperty into this interface.
LocalizableRefProperty	title(LocalizableString title) Set the localizable title.
LocalizableRefProperty	title(String title) Set the plain string title.

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

asDefault, equals, get$ref, getRefFormat, getSimpleRef, getType, hashCode, isType, set$ref, setType

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

allowEmptyValue, getAccess, getAllowEmptyValue, getDescription, getExample, getFormat, getName, getPosition, getReadOnly, getRequired, getTitle, getVendorExtensions, getXml, readOnly, rename, setAccess, setAllowEmptyValue, setDefault, setExample, setExample, setFormat, setName, setPosition, setReadOnly, setRequired, setVendorExtension, setVendorExtensionMap, setVendorExtensions, setXml

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

getAccess, getAllowEmptyValue, getDescription, getExample, getFormat, getName, getPosition, getReadOnly, getRequired, getTitle, getType, getVendorExtensions, getXml, rename, setAccess, setAllowEmptyValue, setDefault, setExample, setExample, setName, setPosition, setReadOnly, setRequired, setXml

Constructor Detail

LocalizableRefProperty

public LocalizableRefProperty()

Creates a new LocalizableRefProperty.

LocalizableRefProperty

public LocalizableRefProperty(String ref)

Creates a new LocalizableRefProperty with the given JSON Reference.

Parameters:

ref - JSON Reference

Method Detail

title

public LocalizableRefProperty title(String title)

Set the plain string title.

Specified by:

title in interface io.swagger.models.properties.Property

Overrides:

title in class io.swagger.models.properties.AbstractProperty

Parameters:

title - The title.

Returns:

This model object.

title

public LocalizableRefProperty title(LocalizableString title)

Set the localizable title.

Parameters:

title - The title.

Returns:

This model object.

description

public LocalizableRefProperty description(LocalizableString description)

Set the localizable description.

Parameters:

description - The title.

Returns:

This model object.

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface io.swagger.models.properties.Property

Overrides:

setTitle in class io.swagger.models.properties.AbstractProperty

description

public LocalizableRefProperty description(String description)

Set the plain string description.

Specified by:

description in interface io.swagger.models.properties.Property

Overrides:

description in class io.swagger.models.properties.RefProperty

Parameters:

description - The title.

Returns:

This model object.

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface io.swagger.models.properties.Property

Overrides:

setDescription in class io.swagger.models.properties.AbstractProperty

getLocalizableTitle

public LocalizableString getLocalizableTitle()

Get the localizable title for Jackson.

Returns:

The title.

getLocalizableDescription

public LocalizableString getLocalizableDescription()

Get the localizable title for Jackson.

Returns:

The title.

setVendorExtension

public void setVendorExtension(String name,
                               Object value)

Pull method from AbstractProperty into this interface.

Parameters:

name - The name.

value - The value.

setFormat

public void setFormat(String format)

Pull method from AbstractProperty into this interface.

Parameters:

format - The format.

getTitle

public String getTitle()

getDescription

public String getDescription()