com.nifty.cloud.ncs.service

## クラス NcsObject

- java.lang.Object
- - com.nifty.cloud.ncs.service.NcsObject

-     public class NcsObject
      extends java.lang.Object

  ニフクラストレージのオブジェクト情報を保持するクラスです。

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

    コンストラクタ
    コンストラクタと説明
    `NcsObject()` 名前を指定せずに新しいNcsObjectを構築します。
    `NcsObject(java.lang.String objectName)` 指定した名前を使用して新しいNcsObjectを構築します。
    `NcsObject(java.lang.String bucketName, java.lang.String objectName)` バケット名、オブジェクト名を指定して新しいNcsObjectを構築します。

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `addHeader(java.lang.String key, java.lang.Object value)` HTTPヘッダを追加します。
    `void` | `addUserMetadata(java.lang.String key, java.lang.String value)` メタデータを追加します。
    `java.lang.String` | `getBucketName()` このオブジェクトが格納されているバケット名を取得します。
    `java.lang.String` | `getCacheControl()` オブジェクトのCache-Controlの設定値を取得します。
    `java.io.InputStream` | `getContent()` オブジェクトのコンテンツ取得します。
    `java.lang.String` | `getContentDisposition()` オブジェクトのContent-Dispositionの設定値を取得します
    `java.lang.String` | `getContentEncoding()` オブジェクトの文字エンコーディングを取得します。
    `long` | `getContentLength()` オブジェクトのコンテンツ長を取得します。
    `java.lang.String` | `getContentMD5()` オブジェクトのMD5ハッシュ値を取得します。
    `java.lang.String` | `getContentType()` オブジェクトのコンテンツタイプを取得します。
    `java.lang.String` | `getETag()` オブジェクトのETagを取得します。
    `java.util.Date` | `getLastModified()` オブジェクトの最終更新日時を取得します。
    `java.util.Map<java.lang.String,java.lang.Object>` | `getMetadata()`
    `java.lang.String` | `getObjectName()` オブジェクト名を取得します。
    `Owner` | `getOwner()` オブジェクトのオーナーを取得します。
    `java.util.Map<java.lang.String,java.lang.Object>` | `getRawMetadata()` 生のメタデータ／ヘッダのマップを取得します。
    `java.util.Map<java.lang.String,java.lang.String>` | `getUserMetadata()` メタデータの取得
    `void` | `setBucketName(java.lang.String bucketName)` このオブジェクトが格納されているバケット名を設定します。
    `void` | `setCacheContro(java.lang.String cacheControl)` オブジェクトのCache-Controlを設定します。
    `void` | `setContent(java.io.InputStream content)` オブジェクトのコンテンツを設定します。
    `void` | `setContentDisposition(java.lang.String contentDisposition)` オブジェクトのContent-Dispositionを設定します。
    `void` | `setContentEncoding(java.lang.String contentEncoding)` オブジェクトの文字エンコーディングを設定します
    `void` | `setContentLength(long length)` オブジェクトのコンテンツ長を設定します。
    `void` | `setContentMD5(java.lang.String md5Base64)` オブジェクトのMD5ハッシュ値を設定します。
    `void` | `setContentType(java.lang.String contentType)` オブジェクトのコンテンツタイプを設定します。
    `void` | `setETag(java.lang.String eTag)` オブジェクトのETagを設定します。
    `void` | `setLastModified(java.util.Date lastModified)` オブジェクトの最終更新日時を設定します。
    `void` | `setObjectName(java.lang.String objectName)` オブジェクト名を設定します。
    `void` | `setOwner(Owner owner)` オブジェクトのオーナーを設定します。
    `java.lang.String` | `toString()`

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

      `equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### NcsObject

          public NcsObject()

      名前を指定せずに新しいNcsObjectを構築します。

    - #### NcsObject

          public NcsObject(java.lang.String objectName)

      指定した名前を使用して新しいNcsObjectを構築します。
      パラメータ:
        `objectName` - オブジェクト名

    - #### NcsObject

          public NcsObject(java.lang.String bucketName,
                           java.lang.String objectName)

      バケット名、オブジェクト名を指定して新しいNcsObjectを構築します。
      パラメータ:
        `bucketName` - バケット名
        `objectName` - オブジェクト名

  - ### メソッドの詳細

    - #### setOwner

          public void setOwner(Owner owner)

      オブジェクトのオーナーを設定します。
      パラメータ:
        `owner` - オブジェクトのオーナー

    - #### getOwner

          public Owner getOwner()

      オブジェクトのオーナーを取得します。
      戻り値:
        オブジェクトのオーナー

    - #### setObjectName

          public void setObjectName(java.lang.String objectName)

      オブジェクト名を設定します。
      パラメータ:
        `objectName` - オブジェクト名

    - #### getObjectName

          public java.lang.String getObjectName()

      オブジェクト名を取得します。
      戻り値:
        オブジェクト名

    - #### setBucketName

          public void setBucketName(java.lang.String bucketName)

      このオブジェクトが格納されているバケット名を設定します。
      パラメータ:
        `bucketName` - このオブジェクトが格納されているバケット名

    - #### getBucketName

          public java.lang.String getBucketName()

      このオブジェクトが格納されているバケット名を取得します。
      戻り値:
        このオブジェクトが格納されているバケット名

    - #### addHeader

          public void addHeader(java.lang.String key,
                                java.lang.Object value)
                         throws java.lang.IllegalArgumentException

      HTTPヘッダを追加します。
      パラメータ:
        `key` - HTTPヘッダのキー
        `value` - HTTPヘッダの値
      例外:
        `java.lang.IllegalArgumentException`

    - #### addUserMetadata

          public void addUserMetadata(java.lang.String key,
                                      java.lang.String value)

      メタデータを追加します。
      パラメータ:
        `key` - メタデータのキー
        `value` - メタデータの値

    - #### getUserMetadata

          public java.util.Map<java.lang.String,java.lang.String> getUserMetadata()

      メタデータの取得
      戻り値:
        メタデータ

    - #### getRawMetadata

          public java.util.Map<java.lang.String,java.lang.Object> getRawMetadata()

      生のメタデータ／ヘッダのマップを取得します。
      戻り値:
        生のメタデータ／ヘッダのマップ

    - #### getMetadata

          public java.util.Map<java.lang.String,java.lang.Object> getMetadata()

    - #### setContent

          public void setContent(java.io.InputStream content)

      オブジェクトのコンテンツを設定します。
      パラメータ:
        `content` - オブジェクトのコンテンツを含む入力ストリーム

    - #### getContent

          public java.io.InputStream getContent()

      オブジェクトのコンテンツ取得します。
      戻り値:
        オブジェクトのコンテンツを含む入力ストリーム

    - #### setLastModified

          public void setLastModified(java.util.Date lastModified)

      オブジェクトの最終更新日時を設定します。
      パラメータ:
        `lastModified` - オブジェクトの最終更新日時

    - #### getLastModified

          public java.util.Date getLastModified()

      オブジェクトの最終更新日時を取得します。
      戻り値:
        オブジェクトの最終更新日時

    - #### setContentLength

          public void setContentLength(long length)

      オブジェクトのコンテンツ長を設定します。
      パラメータ:
        `length` - オブジェクトのコンテンツ長(byte単位)

    - #### getContentLength

          public long getContentLength()

      オブジェクトのコンテンツ長を取得します。
      戻り値:
        オブジェクトのコンテンツ長

    - #### setContentType

          public void setContentType(java.lang.String contentType)

      オブジェクトのコンテンツタイプを設定します。
      パラメータ:
        `contentType` - オブジェクトのコンテンツタイプ

    - #### getContentType

          public java.lang.String getContentType()

      オブジェクトのコンテンツタイプを取得します。
      戻り値:
        オブジェクトのコンテンツタイプ

    - #### setContentEncoding

          public void setContentEncoding(java.lang.String contentEncoding)

      オブジェクトの文字エンコーディングを設定します
      パラメータ:
        `contentEncoding` - オブジェクトの文字エンコーディング
      関連項目:
        http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11

    - #### getContentEncoding

          public java.lang.String getContentEncoding()

      オブジェクトの文字エンコーディングを取得します。
      戻り値:
        オブジェクトの文字エンコーディング

    - #### setCacheContro

          public void setCacheContro(java.lang.String cacheControl)

      オブジェクトのCache-Controlを設定します。
      パラメータ:
        `cacheControl` - オブジェクトのCache-Controlの設定値

    - #### getCacheControl

          public java.lang.String getCacheControl()

      オブジェクトのCache-Controlの設定値を取得します。
      戻り値:
        オブジェクトのCache-Controlの設定値

    - #### setContentMD5

          public void setContentMD5(java.lang.String md5Base64)

      オブジェクトのMD5ハッシュ値を設定します。
      パラメータ:
        `md5Base64` - オブジェクトのMD5ハッシュ値
      関連項目:
        `getContentMD5()`

    - #### getContentMD5

          public java.lang.String getContentMD5()

      オブジェクトのMD5ハッシュ値を取得します。
      戻り値:
        オブジェクトのMD5ハッシュ値

    - #### setContentDisposition

          public void setContentDisposition(java.lang.String contentDisposition)

      オブジェクトのContent-Dispositionを設定します。
      パラメータ:
        `contentDisposition` - オブジェクトのContent-Dispositionの設定値

    - #### getContentDisposition

          public java.lang.String getContentDisposition()

      オブジェクトのContent-Dispositionの設定値を取得します
      戻り値:
        オブジェクトのContent-Dispositionの設定値
      関連項目:
        http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1

    - #### setETag

          public void setETag(java.lang.String eTag)

      オブジェクトのETagを設定します。
      パラメータ:
        `eTag` - オブジェクトのETag

    - #### getETag

          public java.lang.String getETag()

      オブジェクトのETagを取得します。
      戻り値:
        オブジェクトのETag

    - #### toString

          public java.lang.String toString()

      オーバーライド:
        `toString` クラス内 `java.lang.Object`