DConnectSDK.URIBuilder (Device Connect SDK for Android)

java.lang.Object
- org.deviceconnect.message.DConnectSDK.URIBuilder

含まれているクラス:: DConnectSDK

public class DConnectSDK.URIBuilder
extends java.lang.Object

指定された情報からAPIへのURLを提供するクラス.

Host、Port、AccessTokenは、DConnectSDKに設定された値がデフォルトで入っています。

サンプルコード

 URIBuilder builder = sdk.createURIBuilder();
 builder.setProfile(BatteryProfileConstants.PROFILE_NAME)
      .setAttribute(BatteryProfileConstants.ATTRIBUTE_ON_BATTERY_CHANGE)
      .addParameter(DConnectMessage.EXTRA_SERVICE_ID, "xxxxxxxx")

 URI uri = builder.build();
 String uriStr = builder.toString(true);

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`DConnectSDK.URIBuilder`	`addParameter(java.lang.String key, java.lang.String value)` キーバリューでクエリパラメータを追加する.
`android.net.Uri`	`build()` `Uri` オブジェクトを取得する.
`java.lang.String`	`getAccessToken()` アクセストークンを取得する.
`java.lang.String`	`getApi()` APIを取得する.
`java.lang.String`	`getAttribute()` アトリビュートを取得する.
`java.lang.String`	`getHost()` ホスト名を取得する.
`java.lang.String`	`getInterface()` インターフェースを取得する.
`java.lang.String`	`getParameter(java.lang.String name)` 指定したクエリパラメータを取得する.
`java.lang.String`	`getPath()` パスを取得する.
`int`	`getPort()` ポート番号を取得する.
`java.lang.String`	`getProfile()` プロファイルを取得する.
`java.lang.String`	`getScheme()` スキームを取得する.
`java.lang.String`	`getServiceId()` サービスIDを取得する.
`DConnectSDK.URIBuilder`	`removeParameter(java.lang.String key)` 指定されたクエリパラメータを削除する.
`DConnectSDK.URIBuilder`	`setAccessToken(java.lang.String accessToken)` アクセストークンを設定する.
`DConnectSDK.URIBuilder`	`setApi(java.lang.String api)` APIを取得する.
`DConnectSDK.URIBuilder`	`setAttribute(java.lang.String attribute)` アトリビュートを設定する.
`DConnectSDK.URIBuilder`	`setHost(java.lang.String host)` ホスト名を設定する.
`DConnectSDK.URIBuilder`	`setInterface(java.lang.String inter)` インターフェースを設定する.
`DConnectSDK.URIBuilder`	`setPath(java.lang.String path)` APIのパスを文字列で設定する.
`DConnectSDK.URIBuilder`	`setPort(int port)` ポート番号を設定する.
`DConnectSDK.URIBuilder`	`setProfile(java.lang.String profile)` プロファイルを設定する.
`DConnectSDK.URIBuilder`	`setScheme(java.lang.String scheme)` スキームを設定する.
`DConnectSDK.URIBuilder`	`setServiceId(java.lang.String serviceId)` サービスIDを設定する.
`java.lang.String`	`toASCIIString()` ASCIIのオブジェクト文字列を取得する.
`java.lang.String`	`toString()`

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

- メソッドの詳細
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    
    toString クラス内 java.lang.Object
  - toASCIIString
```
public java.lang.String toASCIIString()
```
    ASCIIのオブジェクト文字列を取得する.
    
    戻り値:
    
    オブジェクト文字列
  - getScheme
```
public java.lang.String getScheme()
```
    スキームを取得する.
    
    戻り値:
    
    スキーム
  - setScheme
```
public DConnectSDK.URIBuilder setScheme(java.lang.String scheme)
```
    スキームを設定する.
    
    パラメータ:
    
    scheme - スキーム
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - getHost
```
public java.lang.String getHost()
```
    ホスト名を取得する.
    
    戻り値:
    
    ホスト名
  - setHost
```
public DConnectSDK.URIBuilder setHost(java.lang.String host)
```
    ホスト名を設定する.
    DConnectSDK.setHost(String)で設定された値がでデフォルトでは設定されています。
    
    パラメータ:
    
    host - ホスト名
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - getPort
```
public int getPort()
```
    ポート番号を取得する. ポート番号が指定されていない場合は-1を返す
    
    戻り値:
    
    ポート番号
  - setPort
```
public DConnectSDK.URIBuilder setPort(int port)
```
    ポート番号を設定する.
    DConnectSDK.setPort(int)で設定された値がでデフォルトでは設定されています。
    
    パラメータ:
    
    port - ポート番号
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - getPath
```
public java.lang.String getPath()
```
    パスを取得する.
    
    戻り値:
    
    パス
  - setPath
```
public DConnectSDK.URIBuilder setPath(java.lang.String path)
```
    APIのパスを文字列で設定する.
    このパラメータが設定されている場合はビルド時に api、profile、interface、attribute は無視される。
    
    パラメータ:
    
    path - パス
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - getApi
```
public java.lang.String getApi()
```
    APIを取得する.
    
    戻り値:
    
    API
  - setApi
```
public DConnectSDK.URIBuilder setApi(java.lang.String api)
```
    APIを取得する.
    パスが設定されている場合には、このパラメータは無視される。
    デフォルトでは、gotapiが設定されています。
    
    パラメータ:
    
    api - API
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - getProfile
```
public java.lang.String getProfile()
```
    プロファイルを取得する.
    
    戻り値:
    
    プロファイル
  - setProfile
```
public DConnectSDK.URIBuilder setProfile(java.lang.String profile)
```
    プロファイルを設定する.
    setPath(java.lang.String)でパスが設定されている場合には、このパラメータは無視される。
    
    パラメータ:
    
    profile - プロファイル
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - getInterface
```
public java.lang.String getInterface()
```
    インターフェースを取得する.
    
    戻り値:
    
    インターフェース
  - setInterface
```
public DConnectSDK.URIBuilder setInterface(java.lang.String inter)
```
    インターフェースを設定する.
    setPath(java.lang.String)でパスが設定されている場合には、このパラメータは無視される。
    nullが設定された場合には、インターフェースは省略されます。
    
    パラメータ:
    
    inter - インターフェース
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - getAttribute
```
public java.lang.String getAttribute()
```
    アトリビュートを取得する.
    
    戻り値:
    
    アトリビュート
  - setAttribute
```
public DConnectSDK.URIBuilder setAttribute(java.lang.String attribute)
```
    アトリビュートを設定する.
    setPath(java.lang.String)でパスが設定されている場合には、このパラメータは無視される。
    nullが設定された場合には、アトリビュートは省略されます。
    
    パラメータ:
    
    attribute - アトリビュート
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - setAccessToken
```
public DConnectSDK.URIBuilder setAccessToken(java.lang.String accessToken)
```
    アクセストークンを設定する.
    DConnectSDK.setAccessToken(java.lang.String)で設定された値がデフォルトで指定されている。
    ここで、新たなアクセストークンが指定された場合には上書きする。
    
    パラメータ:
    
    accessToken - アクセストークン
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - getAccessToken
```
public java.lang.String getAccessToken()
```
    アクセストークンを取得する.
    
    戻り値:
    
    アクセストークン
  - setServiceId
```
public DConnectSDK.URIBuilder setServiceId(java.lang.String serviceId)
```
    サービスIDを設定する.
    
    パラメータ:
    
    serviceId - サービスID
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - getServiceId
```
public java.lang.String getServiceId()
```
    サービスIDを取得する.
    設定されていない場合にはnullを返却する。
    
    戻り値:
    
    サービスID
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    指定したクエリパラメータを取得する.
    指定されたクエリパラメータが存在しない場合にはnullを返却する。
    
    パラメータ:
    
    name - クエリパラメータ名
    
    戻り値:
    
    クエリパラメータ
  - addParameter
```
public DConnectSDK.URIBuilder addParameter(java.lang.String key,
                                           java.lang.String value)
```
    キーバリューでクエリパラメータを追加する.
    
    パラメータ:
    
    key - キー
    
    value - バリュー
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - removeParameter
```
public DConnectSDK.URIBuilder removeParameter(java.lang.String key)
```
    指定されたクエリパラメータを削除する.
    
    パラメータ:
    
    key - クエリパラメータ名
    
    戻り値:
    
    DConnectSDK.URIBuilder インスタンス
  - build
```
public android.net.Uri build()
```
    Uri オブジェクトを取得する.
    
    戻り値:
    
    Uri オブジェクト

クラス DConnectSDK.URIBuilder

メソッドのサマリー

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

メソッドの詳細

toString

toASCIIString

getScheme

setScheme

getHost

setHost

getPort

setPort

getPath

setPath

getApi

setApi

getProfile

setProfile

getInterface

setInterface

getAttribute

setAttribute

setAccessToken

getAccessToken

setServiceId

getServiceId

getParameter

addParameter

removeParameter

build