Schema (Device Plug-in SDK for Android)

java.lang.Object
- org.deviceconnect.android.profile.spec.models.AbstractSpec
- - org.deviceconnect.android.profile.spec.models.Schema

すべての実装されたインタフェース:

DConnectSpec, Property

直系の既知のサブクラス:

Definition, Items
```
public class Schema
extends AbstractSpec
implements Property
```
パラメータ、レスポンスなどに使用されるタイプを定義するスキーマ.

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

Schema()

コンストラクタ
コンストラクタと説明
`Schema()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`Schema`	`getAdditionalProperties()` 追加のプロパティを取得します.
`java.util.List<Schema>`	`getAllOf()` allOf のリストを取得します.
`java.lang.String`	`getCollectionFormat()` 配列のフォーマットを取得します.
`java.lang.Object`	`getDefault()` パラメータのデフォルト値を取得します.
`java.lang.String`	`getDescription()` 詳細を取得します.
`java.util.List<java.lang.Object>`	`getEnum()` パラメータに指定できる値の列挙型を取得します.
`ExternalDocs`	`getExternalDocs()` 外部文書を取得します.
`DataFormat`	`getFormat()` パラメータの拡張フォーマットを取得します.
`Items`	`getItems()` 配列のアイテムのタイプを取得します.
`java.lang.Number`	`getMaximum()` パラメータが指定できる最大値を取得します.
`java.lang.Integer`	`getMaxItems()` 配列の最大サイズを取得します.
`java.lang.Integer`	`getMaxLength()` 文字列の最大サイズを取得します.
`java.lang.Integer`	`getMaxProperties()` プロパティの最大個数を取得します.
`java.lang.Number`	`getMinimum()` パラメータが指定できる最小値を取得します.
`java.lang.Integer`	`getMinItems()` 配列の最小サイズを取得します.
`java.lang.Integer`	`getMinLength()` 文字列の最小サイズを設定します.
`java.lang.Integer`	`getMinProperties()` プロパティの最小個数を取得します.
`java.lang.Number`	`getMultipleOf()` 数値の倍数宣言を取得します.
`java.lang.String`	`getPattern()` 文字列のパターンを設定します.
`java.util.Map<java.lang.String,Schema>`	`getProperties()` プロパティのマップを取得します.
`java.lang.String`	`getReference()` リファレンスを取得します.
`java.util.List<java.lang.String>`	`getRequired()` 必須プロパティのリストを取得します.
`java.lang.String`	`getTitle()` タイトルを取得します.
`DataType`	`getType()` パラメータのタイプを取得します.
`java.lang.Boolean`	`isAllowEmptyValue()` 空値許可を確認します.
`java.lang.Boolean`	`isExclusiveMaximum()` 最大値を含めるか確認します.
`java.lang.Boolean`	`isExclusiveMinimum()` 最小値を含めるか確認します.
`java.lang.Boolean`	`isUniqueItems()` 配列の全ての値がユニーク宣言を取得します.
`void`	`setAdditionalProperties(Schema additionalProperties)` 追加のプロパティを設定します.
`void`	`setAllOf(java.util.List<Schema> allOf)` allOf のリストを設定します.
`void`	`setAllowEmptyValue(java.lang.Boolean allowEmptyValue)` 空値許可を設定します.
`void`	`setCollectionFormat(java.lang.String collectionFormat)` 配列のフォーマットを設定します.
`void`	`setDefault(java.lang.Object aDefault)` パラメータのデフォルト値を設定します.
`void`	`setDescription(java.lang.String description)` 詳細を設定します.
`void`	`setEnum(java.util.List<java.lang.Object> anEnum)` パラメータに指定できる値の列挙型を設定します.
`void`	`setExclusiveMaximum(java.lang.Boolean exclusiveMaximum)` 最大値を含めるかを設定します.
`void`	`setExclusiveMinimum(java.lang.Boolean exclusiveMinimum)` 最小値を含めるかを設定します.
`void`	`setExternalDocs(ExternalDocs externalDocs)` 外部文書を設定します.
`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`	`setMaxProperties(java.lang.Integer maxProperties)` プロパティの最大個数を設定します.
`void`	`setMinimum(java.lang.Number minimum)` パラメータが指定できる最小値を設定します.
`void`	`setMinItems(java.lang.Integer minItems)` 配列の最小サイズを設定します.
`void`	`setMinLength(java.lang.Integer minLength)` 文字列の最小サイズを設定します.
`void`	`setMinProperties(java.lang.Integer minProperties)` プロパティの最小個数を設定します.
`void`	`setMultipleOf(java.lang.Number multipleOf)` 数値パラメータが multipleOf の倍数宣言を設定します.
`void`	`setPattern(java.lang.String pattern)` 文字列のパターンを設定します.
`void`	`setProperties(java.util.Map<java.lang.String,Schema> properties)` プロパティのマップを設定します.
`void`	`setReference(java.lang.String reference)` リファレンスを設定します.
`void`	`setRequired(java.util.List<java.lang.String> required)` 必須プロパティのリストを設定します.
`void`	`setTitle(java.lang.String title)` タイトルを設定します.
`void`	`setType(DataType type)` パラメータのタイプを設定します.
`void`	`setUniqueItems(java.lang.Boolean uniqueItems)` 配列の全ての値がユニーク宣言を設定します.
`android.os.Bundle`	`toBundle()` プロファイル定義書を Bundle に変換します.

クラスから継承されたメソッド org.deviceconnect.android.profile.spec.models.AbstractSpec
addVendorExtension, copyEnum, copyNumber, copyVendorExtensions, getVendorExtensions, removeVendorExtension, setVendorExtensions

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - Schema
```
public Schema()
```
- メソッドの詳細
  - getExternalDocs
```
public ExternalDocs getExternalDocs()
```
    外部文書を取得します.
    
    戻り値:
    
    外部文書
  - setExternalDocs
```
public void setExternalDocs(ExternalDocs externalDocs)
```
    外部文書を設定します.
    
    パラメータ:
    
    externalDocs - 外部文書
  - getReference
```
public java.lang.String getReference()
```
    リファレンスを取得します.
    
    戻り値:
    
    リファレンス
  - setReference
```
public void setReference(java.lang.String reference)
```
    リファレンスを設定します.
    
    パラメータ:
    
    reference - リファレンス
  - getTitle
```
public java.lang.String getTitle()
```
    タイトルを取得します.
    
    戻り値:
    
    タイトル
  - setTitle
```
public void setTitle(java.lang.String title)
```
    タイトルを設定します.
    
    パラメータ:
    
    title - タイトル
  - getDescription
```
public java.lang.String getDescription()
```
    詳細を取得します.
    
    戻り値:
    
    詳細
  - setDescription
```
public void setDescription(java.lang.String description)
```
    詳細を設定します.
    
    パラメータ:
    
    description - 詳細
  - getMinimum
```
public java.lang.Number getMinimum()
```
    インタフェースからコピーされた説明: Property
    
    パラメータが指定できる最小値を取得します.
    
    定義:
    
    getMinimum インタフェース内 Property
    
    戻り値:
    
    パラメータが指定できる最小値
  - setMinimum
```
public void setMinimum(java.lang.Number minimum)
```
    インタフェースからコピーされた説明: Property
    
    パラメータが指定できる最小値を設定します.
    
    定義:
    
    setMinimum インタフェース内 Property
    
    パラメータ:
    
    minimum - パラメータが指定できる最小値
  - getMaximum
```
public java.lang.Number getMaximum()
```
    インタフェースからコピーされた説明: Property
    
    パラメータが指定できる最大値を取得します.
    
    定義:
    
    getMaximum インタフェース内 Property
    
    戻り値:
    
    パラメータの最大値
  - setMaximum
```
public void setMaximum(java.lang.Number maximum)
```
    インタフェースからコピーされた説明: Property
    
    パラメータが指定できる最大値を設定します.
    
    定義:
    
    setMaximum インタフェース内 Property
    
    パラメータ:
    
    maximum - パラメータの最大値
  - isExclusiveMinimum
```
public java.lang.Boolean isExclusiveMinimum()
```
    インタフェースからコピーされた説明: Property
    
    最小値を含めるか確認します.
    
    定義:
    
    isExclusiveMinimum インタフェース内 Property
    
    戻り値:
    
    最小値を含めない場合はtrue、それ以外はfalse
  - setExclusiveMinimum
```
public void setExclusiveMinimum(java.lang.Boolean exclusiveMinimum)
```
    インタフェースからコピーされた説明: Property
    
    最小値を含めるかを設定します.
    null が指定された場合には、false として扱います。
    
    定義:
    
    setExclusiveMinimum インタフェース内 Property
    
    パラメータ:
    
    exclusiveMinimum - 最小値を含めない場合はtrue、それ以外はfalse
  - isExclusiveMaximum
```
public java.lang.Boolean isExclusiveMaximum()
```
    インタフェースからコピーされた説明: Property
    
    最大値を含めるか確認します.
    
    定義:
    
    isExclusiveMaximum インタフェース内 Property
    
    戻り値:
    
    最大値を含めない場合はtrue、それ以外はfalse
  - setExclusiveMaximum
```
public void setExclusiveMaximum(java.lang.Boolean exclusiveMaximum)
```
    インタフェースからコピーされた説明: Property
    
    最大値を含めるかを設定します.
    null が指定された場合には、false として扱います。
    
    定義:
    
    setExclusiveMaximum インタフェース内 Property
    
    パラメータ:
    
    exclusiveMaximum - 最大値を含めない場合はtrue、それ以外はfalse
  - getMinLength
```
public java.lang.Integer getMinLength()
```
    インタフェースからコピーされた説明: Property
    
    文字列の最小サイズを設定します.
    
    定義:
    
    getMinLength インタフェース内 Property
    
    戻り値:
    
    文字列の最小サイズ
  - setMinLength
```
public void setMinLength(java.lang.Integer minLength)
```
    インタフェースからコピーされた説明: Property
    
    文字列の最小サイズを設定します.
    
    定義:
    
    setMinLength インタフェース内 Property
    
    パラメータ:
    
    minLength - 文字列の最小サイズ
  - getMaxLength
```
public java.lang.Integer getMaxLength()
```
    インタフェースからコピーされた説明: Property
    
    文字列の最大サイズを取得します.
    
    定義:
    
    getMaxLength インタフェース内 Property
    
    戻り値:
    
    文字列の最大サイズ
  - setMaxLength
```
public void setMaxLength(java.lang.Integer maxLength)
```
    インタフェースからコピーされた説明: Property
    
    文字列の最大サイズを設定します.
    
    定義:
    
    setMaxLength インタフェース内 Property
    
    パラメータ:
    
    maxLength - 文字列の最大サイズ
  - getPattern
```
public java.lang.String getPattern()
```
    インタフェースからコピーされた説明: Property
    
    文字列のパターンを設定します.
    正規表現でパターンを設定することができます。
    
    定義:
    
    getPattern インタフェース内 Property
    
    戻り値:
    
    文字列のパターン
  - setPattern
```
public void setPattern(java.lang.String pattern)
```
    インタフェースからコピーされた説明: Property
    
    文字列のパターンを設定します.
    
    定義:
    
    setPattern インタフェース内 Property
    
    パラメータ:
    
    pattern - 文字列のパターン
  - getMaxItems
```
public java.lang.Integer getMaxItems()
```
    インタフェースからコピーされた説明: Property
    
    配列の最大サイズを取得します.
    
    定義:
    
    getMaxItems インタフェース内 Property
    
    戻り値:
    
    配列の最大サイズ
  - setMaxItems
```
public void setMaxItems(java.lang.Integer maxItems)
```
    インタフェースからコピーされた説明: Property
    
    配列の最大サイズを設定します.
    
    定義:
    
    setMaxItems インタフェース内 Property
    
    パラメータ:
    
    maxItems - 配列の最大サイズ
  - getMinItems
```
public java.lang.Integer getMinItems()
```
    インタフェースからコピーされた説明: Property
    
    配列の最小サイズを取得します.
    
    定義:
    
    getMinItems インタフェース内 Property
    
    戻り値:
    
    配列の最小サイズ
  - setMinItems
```
public void setMinItems(java.lang.Integer minItems)
```
    インタフェースからコピーされた説明: Property
    
    配列の最小サイズを設定します.
    
    定義:
    
    setMinItems インタフェース内 Property
    
    パラメータ:
    
    minItems - 配列の最小サイズ
  - isUniqueItems
```
public java.lang.Boolean isUniqueItems()
```
    インタフェースからコピーされた説明: Property
    
    配列の全ての値がユニーク宣言を取得します.
    uniqueItems が true の場合には、配列の中身が全てユニークになっている必要があります。
    
    定義:
    
    isUniqueItems インタフェース内 Property
    
    戻り値:
    
    配列の全ての値がユニークなる場合はtrue、それ以外は false
  - setUniqueItems
```
public void setUniqueItems(java.lang.Boolean uniqueItems)
```
    インタフェースからコピーされた説明: Property
    
    配列の全ての値がユニーク宣言を設定します.
    
    定義:
    
    setUniqueItems インタフェース内 Property
    
    パラメータ:
    
    uniqueItems - 配列の全ての値がユニークなる場合はtrue、それ以外は false
  - getMultipleOf
```
public java.lang.Number getMultipleOf()
```
    インタフェースからコピーされた説明: Property
    
    数値の倍数宣言を取得します.
    multipleOfが設定されている場合は、指定された値で割り切れるようになる必要があります。
    
    定義:
    
    getMultipleOf インタフェース内 Property
    
    戻り値:
    
    multipleOf の値
  - setMultipleOf
```
public void setMultipleOf(java.lang.Number multipleOf)
```
    インタフェースからコピーされた説明: Property
    
    数値パラメータが multipleOf の倍数宣言を設定します.
    
    定義:
    
    setMultipleOf インタフェース内 Property
    
    パラメータ:
    
    multipleOf - 値
  - getEnum
```
public java.util.List<java.lang.Object> getEnum()
```
    インタフェースからコピーされた説明: Property
    
    パラメータに指定できる値の列挙型を取得します.
    
    定義:
    
    getEnum インタフェース内 Property
    
    戻り値:
    
    パラメータに指定できる値の列挙型
  - setEnum
```
public void setEnum(java.util.List<java.lang.Object> anEnum)
```
    インタフェースからコピーされた説明: Property
    
    パラメータに指定できる値の列挙型を設定します.
    
    定義:
    
    setEnum インタフェース内 Property
    
    パラメータ:
    
    anEnum - パラメータに指定できる値の列挙型
  - getType
```
public DataType getType()
```
    インタフェースからコピーされた説明: Property
    
    パラメータのタイプを取得します.
    必須パラメータになります。
    
    定義:
    
    getType インタフェース内 Property
    
    戻り値:
    
    パラメータのタイプ
  - setType
```
public void setType(DataType type)
```
    インタフェースからコピーされた説明: Property
    
    パラメータのタイプを設定します.
    必須パラメータになります。
    
    定義:
    
    setType インタフェース内 Property
    
    パラメータ:
    
    type - パラメータのタイプ
  - getFormat
```
public DataFormat getFormat()
```
    インタフェースからコピーされた説明: Property
    
    パラメータの拡張フォーマットを取得します.
    
    定義:
    
    getFormat インタフェース内 Property
    
    戻り値:
    
    パラメータの拡張フォーマット
  - setFormat
```
public void setFormat(DataFormat format)
```
    インタフェースからコピーされた説明: Property
    
    パラメータの拡張フォーマットを設定します.
    
    定義:
    
    setFormat インタフェース内 Property
    
    パラメータ:
    
    format - パラメータの拡張フォーマット
  - getDefault
```
public java.lang.Object getDefault()
```
    インタフェースからコピーされた説明: Property
    
    パラメータのデフォルト値を取得します.
    
    定義:
    
    getDefault インタフェース内 Property
    
    戻り値:
    
    パラメータのデフォルト値
  - setDefault
```
public void setDefault(java.lang.Object aDefault)
```
    インタフェースからコピーされた説明: Property
    
    パラメータのデフォルト値を設定します.
    
    定義:
    
    setDefault インタフェース内 Property
    
    パラメータ:
    
    aDefault - パラメータのデフォルト値
  - getItems
```
public Items getItems()
```
    インタフェースからコピーされた説明: Property
    
    配列のアイテムのタイプを取得します.
    
    定義:
    
    getItems インタフェース内 Property
    
    戻り値:
    
    配列のフォーマット
  - setItems
```
public void setItems(Items items)
```
    インタフェースからコピーされた説明: Property
    
    配列のアイテムのタイプを設定します.
    
    定義:
    
    setItems インタフェース内 Property
    
    パラメータ:
    
    items - 配列のアイテムのタイプ
  - isAllowEmptyValue
```
public java.lang.Boolean isAllowEmptyValue()
```
    インタフェースからコピーされた説明: Property
    
    空値許可を確認します.
    
    定義:
    
    isAllowEmptyValue インタフェース内 Property
    
    戻り値:
    
    空値を許可する場合はtrue、それ以外はfalse
  - setAllowEmptyValue
```
public void setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
```
    インタフェースからコピーされた説明: Property
    
    空値許可を設定します.
    null が指定された場合には、false として扱います。
    
    定義:
    
    setAllowEmptyValue インタフェース内 Property
    
    パラメータ:
    
    allowEmptyValue - 空値を許可する場合はtrue、それ以外はfalse
  - getCollectionFormat
```
public java.lang.String getCollectionFormat()
```
    インタフェースからコピーされた説明: Property
    
    配列のフォーマットを取得します.
    Property.getType() が DataType.ARRAY の場合に使用される配列のフォーマット. csv, ssv, tsv, pipes, multi が設定可能です。
    
    省略された場合は csv になります。
    
    定義:
    
    getCollectionFormat インタフェース内 Property
    
    戻り値:
    
    配列のフォーマット
  - setCollectionFormat
```
public void setCollectionFormat(java.lang.String collectionFormat)
```
    インタフェースからコピーされた説明: Property
    
    配列のフォーマットを設定します.
    
    定義:
    
    setCollectionFormat インタフェース内 Property
    
    パラメータ:
    
    collectionFormat - 配列のフォーマット
  - getAllOf
```
public java.util.List<Schema> getAllOf()
```
    allOf のリストを取得します.
    
    戻り値:
    
    allOf のリスト
  - setAllOf
```
public void setAllOf(java.util.List<Schema> allOf)
```
    allOf のリストを設定します.
    
    パラメータ:
    
    allOf - allOf のリスト
  - getMaxProperties
```
public java.lang.Integer getMaxProperties()
```
    プロパティの最大個数を取得します.
    
    戻り値:
    
    プロパティの最大個数
  - setMaxProperties
```
public void setMaxProperties(java.lang.Integer maxProperties)
```
    プロパティの最大個数を設定します.
    
    パラメータ:
    
    maxProperties - プロパティの最大個数
  - getMinProperties
```
public java.lang.Integer getMinProperties()
```
    プロパティの最小個数を取得します.
    
    戻り値:
    
    プロパティの最小個数
  - setMinProperties
```
public void setMinProperties(java.lang.Integer minProperties)
```
    プロパティの最小個数を設定します.
    
    パラメータ:
    
    minProperties - プロパティの最小個数を
  - getRequired
```
public java.util.List<java.lang.String> getRequired()
```
    必須プロパティのリストを取得します.
    
    戻り値:
    
    必須プロパティのリスト
  - setRequired
```
public void setRequired(java.util.List<java.lang.String> required)
```
    必須プロパティのリストを設定します.
    
    パラメータ:
    
    required - 必須プロパティのリスト
  - getProperties
```
public java.util.Map<java.lang.String,Schema> getProperties()
```
    プロパティのマップを取得します.
    
    戻り値:
    
    プロパティのマップ
  - setProperties
```
public void setProperties(java.util.Map<java.lang.String,Schema> properties)
```
    プロパティのマップを設定します.
    
    パラメータ:
    
    properties - プロパティのマップ
  - getAdditionalProperties
```
public Schema getAdditionalProperties()
```
    追加のプロパティを取得します.
    
    戻り値:
    
    追加のプロパティ
  - setAdditionalProperties
```
public void setAdditionalProperties(Schema additionalProperties)
```
    追加のプロパティを設定します.
    
    パラメータ:
    
    additionalProperties - 追加のプロパティ
  - toBundle
```
public android.os.Bundle toBundle()
```
    インタフェースからコピーされた説明: DConnectSpec
    
    プロファイル定義書を Bundle に変換します.
    
    定義:
    
    toBundle インタフェース内 DConnectSpec
    
    戻り値:
    
    プロファイル定義書

クラス Schema

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.deviceconnect.android.profile.spec.models.AbstractSpec

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

Schema

メソッドの詳細

getExternalDocs

setExternalDocs

getReference

setReference

getTitle

setTitle

getDescription

setDescription

getMinimum

setMinimum

getMaximum

setMaximum

isExclusiveMinimum

setExclusiveMinimum

isExclusiveMaximum

setExclusiveMaximum

getMinLength

setMinLength

getMaxLength

setMaxLength

getPattern

setPattern

getMaxItems

setMaxItems

getMinItems

setMinItems

isUniqueItems

setUniqueItems

getMultipleOf

setMultipleOf

getEnum

setEnum

getType

setType

getFormat

setFormat

getDefault

setDefault

getItems

setItems

isAllowEmptyValue

setAllowEmptyValue

getCollectionFormat

setCollectionFormat

getAllOf

setAllOf

getMaxProperties

setMaxProperties

getMinProperties

setMinProperties

getRequired

setRequired

getProperties

setProperties

getAdditionalProperties

setAdditionalProperties

toBundle