public interface Property
修飾子とタイプ | メソッドと説明 |
---|---|
java.lang.String |
getCollectionFormat()
配列のフォーマットを取得します.
|
java.lang.Object |
getDefault()
パラメータのデフォルト値を取得します.
|
java.util.List<java.lang.Object> |
getEnum()
パラメータに指定できる値の列挙型を取得します.
|
DataFormat |
getFormat()
パラメータの拡張フォーマットを取得します.
|
Items |
getItems()
配列のアイテムのタイプを取得します.
|
java.lang.Number |
getMaximum()
パラメータが指定できる最大値を取得します.
|
java.lang.Integer |
getMaxItems()
配列の最大サイズを取得します.
|
java.lang.Integer |
getMaxLength()
文字列の最大サイズを取得します.
|
java.lang.Number |
getMinimum()
パラメータが指定できる最小値を取得します.
|
java.lang.Integer |
getMinItems()
配列の最小サイズを取得します.
|
java.lang.Integer |
getMinLength()
文字列の最小サイズを設定します.
|
java.lang.Number |
getMultipleOf()
数値の倍数宣言を取得します.
|
java.lang.String |
getPattern()
文字列のパターンを設定します.
|
DataType |
getType()
パラメータのタイプを取得します.
|
java.lang.Boolean |
isAllowEmptyValue()
空値許可を確認します.
|
java.lang.Boolean |
isExclusiveMaximum()
最大値を含めるか確認します.
|
java.lang.Boolean |
isExclusiveMinimum()
最小値を含めるか確認します.
|
java.lang.Boolean |
isUniqueItems()
配列の全ての値がユニーク宣言を取得します.
|
void |
setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
空値許可を設定します.
|
void |
setCollectionFormat(java.lang.String collectionFormat)
配列のフォーマットを設定します.
|
void |
setDefault(java.lang.Object aDefault)
パラメータのデフォルト値を設定します.
|
void |
setEnum(java.util.List<java.lang.Object> anEnum)
パラメータに指定できる値の列挙型を設定します.
|
void |
setExclusiveMaximum(java.lang.Boolean exclusiveMaximum)
最大値を含めるかを設定します.
|
void |
setExclusiveMinimum(java.lang.Boolean exclusiveMinimum)
最小値を含めるかを設定します.
|
void |
setFormat(DataFormat format)
パラメータの拡張フォーマットを設定します.
|
void |
setItems(Items items)
配列のアイテムのタイプを設定します.
|
void |
setMaximum(java.lang.Number maximum)
パラメータが指定できる最大値を設定します.
|
void |
setMaxItems(java.lang.Integer maxItems)
配列の最大サイズを設定します.
|
void |
setMaxLength(java.lang.Integer maxLength)
文字列の最大サイズを設定します.
|
void |
setMinimum(java.lang.Number minimum)
パラメータが指定できる最小値を設定します.
|
void |
setMinItems(java.lang.Integer minItems)
配列の最小サイズを設定します.
|
void |
setMinLength(java.lang.Integer minLength)
文字列の最小サイズを設定します.
|
void |
setMultipleOf(java.lang.Number multipleOf)
数値パラメータが multipleOf の倍数宣言を設定します.
|
void |
setPattern(java.lang.String pattern)
文字列のパターンを設定します.
|
void |
setType(DataType type)
パラメータのタイプを設定します.
|
void |
setUniqueItems(java.lang.Boolean uniqueItems)
配列の全ての値がユニーク宣言を設定します.
|
DataType getType()
必須パラメータになります。
void setType(DataType type)
必須パラメータになります。
type
- パラメータのタイプDataFormat getFormat()
void setFormat(DataFormat format)
format
- パラメータの拡張フォーマットjava.lang.Object getDefault()
void setDefault(java.lang.Object aDefault)
aDefault
- パラメータのデフォルト値java.lang.Number getMaximum()
void setMaximum(java.lang.Number maximum)
maximum
- パラメータの最大値java.lang.Boolean isExclusiveMaximum()
void setExclusiveMaximum(java.lang.Boolean exclusiveMaximum)
null が指定された場合には、false として扱います。
exclusiveMaximum
- 最大値を含めない場合はtrue、それ以外はfalsejava.lang.Number getMinimum()
void setMinimum(java.lang.Number minimum)
minimum
- パラメータが指定できる最小値java.lang.Boolean isExclusiveMinimum()
void setExclusiveMinimum(java.lang.Boolean exclusiveMinimum)
null が指定された場合には、false として扱います。
exclusiveMinimum
- 最小値を含めない場合はtrue、それ以外はfalsejava.lang.Integer getMaxLength()
void setMaxLength(java.lang.Integer maxLength)
maxLength
- 文字列の最大サイズjava.lang.Integer getMinLength()
void setMinLength(java.lang.Integer minLength)
minLength
- 文字列の最小サイズjava.lang.String getPattern()
正規表現でパターンを設定することができます。
void setPattern(java.lang.String pattern)
pattern
- 文字列のパターンjava.lang.Boolean isAllowEmptyValue()
void setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
null が指定された場合には、false として扱います。
allowEmptyValue
- 空値を許可する場合はtrue、それ以外はfalseItems getItems()
void setItems(Items items)
items
- 配列のアイテムのタイプjava.lang.String getCollectionFormat()
getType()
が DataType.ARRAY
の場合に使用される配列のフォーマット.
csv, ssv, tsv, pipes, multi が設定可能です。
省略された場合は csv になります。
void setCollectionFormat(java.lang.String collectionFormat)
collectionFormat
- 配列のフォーマットjava.lang.Integer getMaxItems()
void setMaxItems(java.lang.Integer maxItems)
maxItems
- 配列の最大サイズjava.lang.Integer getMinItems()
void setMinItems(java.lang.Integer minItems)
minItems
- 配列の最小サイズjava.lang.Boolean isUniqueItems()
uniqueItems が true の場合には、配列の中身が全てユニークになっている必要があります。
void setUniqueItems(java.lang.Boolean uniqueItems)
uniqueItems
- 配列の全ての値がユニークなる場合はtrue、それ以外は falsejava.util.List<java.lang.Object> getEnum()
void setEnum(java.util.List<java.lang.Object> anEnum)
anEnum
- パラメータに指定できる値の列挙型java.lang.Number getMultipleOf()
multipleOfが設定されている場合は、指定された値で割り切れるようになる必要があります。
void setMultipleOf(java.lang.Number multipleOf)
multipleOf
- 値