com.nifty.cloud.ncs.service

## クラス ObjectListing

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

-     public class ObjectListing
      extends java.lang.Object

  バケット内のオブジェクト一覧取得用クラス

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `addCommonPrefix(java.lang.String prefix)` CommonPrefixを追加します。
    `void` | `addObject(NcsObjectContents object)` オブジェクトを追加します。
    `java.lang.String` | `getBucketName()` オブジェクト一覧取得対象のバケット名を取得します。
    `java.util.List<java.lang.String>` | `getCommonPrefixes()` CommonPrefixesのリストを取得します。
    `java.lang.String` | `getDelimiter()` delimiterパラメータを取得します。
    `java.lang.String` | `getMarker()` markerパラメータを取得します。
    `int` | `getMaxKeys()` max-keysパラメータを取得します。
    `java.lang.String` | `getNextMarker()` NextMarkerを取得します。
    `java.util.List<NcsObjectContents>` | `getObjectList()` オブジェクト一覧を取得します。
    `java.lang.String` | `getPrefix()` prefixパラメータを取得します。
    `boolean` | `isTruncated()` isTruncatedプロパティ値を取得します。
    `void` | `setBucketName(java.lang.String bucketName)` オブジェクト一覧取得対象のバケット名を設定します。
    `void` | `setCommonPrefixes(java.util.List<java.lang.String> commonPrefixes)` CommonPrefixを設定します。
    `void` | `setDelimiter(java.lang.String delimiter)` delimiterパラメータを設定します。
    `void` | `setMarker(java.lang.String marker)` markerパラメータを設定します。
    `void` | `setMaxKeys(int maxKeys)` max-keysパラメータを設定します。
    `void` | `setNextMarker(java.lang.String nextMarker)` NextMarkerを設定します。
    `void` | `setPrefix(java.lang.String prefix)` prefixパラメータを設定します。
    `void` | `setTruncated(boolean isTruncated)` isTruncatedプロパティを設定します。

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

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

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

    - #### ObjectListing

          public ObjectListing()

  - ### メソッドの詳細

    - #### setBucketName

          public void setBucketName(java.lang.String bucketName)

      オブジェクト一覧取得対象のバケット名を設定します。
      パラメータ:
        `bucketName` - オブジェクト一覧取得対象のバケット名

    - #### getBucketName

          public java.lang.String getBucketName()

      オブジェクト一覧取得対象のバケット名を取得します。
      戻り値:
        オブジェクト一覧取得対象のバケット名

    - #### addObject

          public void addObject(NcsObjectContents object)

      オブジェクトを追加します。
      パラメータ:
        `object` - オブジェクト情報

    - #### getObjectList

          public java.util.List<NcsObjectContents> getObjectList()

      オブジェクト一覧を取得します。
      戻り値:
        NcsObjectContentsのリスト

    - #### setCommonPrefixes

          public void setCommonPrefixes(java.util.List<java.lang.String> commonPrefixes)

      CommonPrefixを設定します。 要求にdelimiterパラメータが含まれている場合に設定されます。
      パラメータ:
        `commonPrefixes` - CommonPrefixesのキー

    - #### addCommonPrefix

          public void addCommonPrefix(java.lang.String prefix)

      CommonPrefixを追加します。 要求にdelimiterパラメータが含まれている場合に設定されます。
      パラメータ:
        `prefix` - CommonPrefixのキー

    - #### getCommonPrefixes

          public java.util.List<java.lang.String> getCommonPrefixes()

      CommonPrefixesのリストを取得します。
      戻り値:
        CommonPrefixesが含まれている場合はCommonPrefixesのリスト、そうでない場合は空のリスト

    - #### setNextMarker

          public void setNextMarker(java.lang.String nextMarker)

      NextMarkerを設定します。
      パラメータ:
        `nextMarker` - オブジェクト一覧が切り捨てられた場合に設定され、この値を次回要求時に設定すると 切り捨てられたリストの続きを取得することができます。

    - #### getNextMarker

          public java.lang.String getNextMarker()

      NextMarkerを取得します。NextMarkerは、次回要求時に、次項を参照するためのmarkerです。 オブジェクト一覧が切り捨てられていない場合、このメソッドは`null`を返却します。 切り捨てられた要求の場合、この値は、一覧に含まれるオブジェクトのkey、およびCommonPrefixesのうち 辞書的に見て一番後ろのものになります。
      戻り値:
        NextMarker。この値は、リストに含まれるオブジェクト名、およびCommonPrefixesのうち 辞書的に見て一番後ろのものになります。 オブジェクト一覧が切り捨てられていない場合は`null`を返却します。

    - #### setMarker

          public void setMarker(java.lang.String marker)

      markerパラメータを設定します。
      パラメータ:
        `marker` - markerパラメータ

    - #### getMarker

          public java.lang.String getMarker()

      markerパラメータを取得します。 このパラメータが指定された場合、オブジェクト一覧に含まれるオブジェクト名、およびCommonPrefixesのうち、 markerよりもアルファベット順で後にあるものを全てを取得します。
      戻り値:
        markerパラメータ。 markerが指定されていない場合`null`

    - #### setMaxKeys

          public void setMaxKeys(int maxKeys)

      max-keysパラメータを設定します。
      パラメータ:
        `maxKeys` - max-keysパラメータ。

    - #### getMaxKeys

          public int getMaxKeys()

      max-keysパラメータを取得します。
      戻り値:
        max-keyパラメータ。 値が指定されていない場合、ニフクラストレージで定められるデフォルトのmax-key値

    - #### setPrefix

          public void setPrefix(java.lang.String prefix)

      prefixパラメータを設定します。
      パラメータ:
        `prefix` - prefixパラメータ

    - #### getPrefix

          public java.lang.String getPrefix()

      prefixパラメータを取得します。 オブジェクト一覧は指定したprefixから開始されます。
      戻り値:
        prefixパラメータ。 prefixが指定されていない場合`null`

    - #### setDelimiter

          public void setDelimiter(java.lang.String delimiter)

      delimiterパラメータを設定します。
      パラメータ:
        `delimiter` - delimiterパラメータ

    - #### getDelimiter

          public java.lang.String getDelimiter()

      delimiterパラメータを取得します。
      戻り値:
        delimiterパラメータ。 delimiterが指定されていない場合、`null`

    - #### setTruncated

          public void setTruncated(boolean isTruncated)

      isTruncatedプロパティを設定します。 isTruncatedプロパティは、一覧が切り捨てられていないかどうかを示す値です。
      パラメータ:
        `isTruncated` - オブジェクト一覧が完全な場合は`true`。 そうでなければ`false`

    - #### isTruncated

          public boolean isTruncated()

      isTruncatedプロパティ値を取得します。
      戻り値:
        オブジェクト一覧が不完全な場合`true`、そうでなければ`false`。