パッケージ jakarta.ws.rs.core

クラス CacheControl


  • public class CacheControl
    extends ObjectSE
    HTTP Cache-Control レスポンスヘッダーの値の抽象化。
    導入:
    1.0
    作成者:
    Paul Sandoz, Marc Hadley
    関連事項:
    HTTP/1.1 セクション 14.9
    • コンストラクターのサマリー

      コンストラクター  
      コンストラクター 説明
      CacheControl()
      CacheControl の新しいインスタンスを作成します。
    • メソッドのサマリー

      すべてのメソッド   静的メソッド   インスタンスメソッド   具象メソッド   非推奨のメソッド  
      修飾子と型 メソッド 説明
      booleanequals​(ObjectSE obj)
      オブジェクト引数をこのキャッシュコントロールと比較して、すべてのプロパティ値を考慮してそれらが同じであるかどうかを確認します。
      MapSE<StringSE,​StringSE>getCacheExtension()
      拡張キャッシュ制御ディレクティブのセットに対応します。
      intgetMaxAge()
      max-age キャッシュ制御ディレクティブに対応します。
      ListSE<StringSE>getNoCacheFields()
      キャッシュなしキャッシュ制御ディレクティブの値に対応します。
      ListSE<StringSE>getPrivateFields()
      プライベートキャッシュ制御ディレクティブの値に対応します。
      intgetSMaxAge()
      s-maxage キャッシュ制御ディレクティブに対応します。
      inthashCode()
      キャッシュ制御プロパティからハッシュコードを生成します。
      booleanisMustRevalidate()
      検証が必要なキャッシュ制御ディレクティブに対応します。
      booleanisNoCache()
      no-cache cachecontrol ディレクティブに対応します。
      booleanisNoStore()
      no-store キャッシュ制御ディレクティブに対応します。
      booleanisNoTransform()
      no-transform キャッシュ制御ディレクティブに対応します。
      booleanisPrivate()
      プライベートキャッシュ制御ディレクティブに対応します。
      booleanisProxyRevalidate()
      proxy-revalidate キャッシュ制御ディレクティブに対応します。
      voidsetMaxAge​(int maxAge)
      max-age キャッシュ制御ディレクティブに対応します。
      voidsetMustRevalidate​(boolean mustRevalidate)
      検証が必要なキャッシュ制御ディレクティブに対応します。
      voidsetNoCache​(boolean noCache)
      no-cache cachecontrol ディレクティブに対応します。
      voidsetNoStore​(boolean noStore)
      no-store キャッシュ制御ディレクティブに対応します。
      voidsetNoTransform​(boolean noTransform)
      no-transform キャッシュ制御ディレクティブに対応します。
      voidsetPrivate​(boolean flag)
      プライベートキャッシュ制御ディレクティブに対応します。
      voidsetProxyRevalidate​(boolean proxyRevalidate)
      検証が必要なキャッシュ制御ディレクティブに対応します。
      voidsetSMaxAge​(int smaxAge)
      s-maxage キャッシュ制御ディレクティブに対応します。
      StringSEtoString()
      使用すべきではありません。
      toString() メソッドの形式は、将来のバージョンで変更される可能性があります。
      static CacheControlvalueOf​(StringSE value)
      使用すべきではありません。
      このメソッドは、将来のバージョンで削除される予定です。
    • コンストラクターの詳細

      • CacheControl

        public CacheControl()
        CacheControl の新しいインスタンスを作成します。新しいインスタンスのデフォルト設定は次のとおりです。
        • プライベート = false
        • noCache = 偽
        • noStore = 偽
        • noTransform = 真
        • mustRevalidate = 偽
        • proxyRevalidate = 偽
        • プライベートフィールドの空のリスト
        • キャッシュなしフィールドの空のリスト
        • キャッシュ拡張機能の空のマップ
    • メソッドの詳細

      • valueOf

        @DeprecatedSE
        public static CacheControl valueOf​(StringSE value)
        使用すべきではありません。
        このメソッドは、将来のバージョンで削除される予定です。代わりに、RuntimeDelegate.getInstance()。createHeaderDelegate(CacheControl.class).fromString(value)を使用してください。
        指定された文字列を解析して、CacheControl の新しいインスタンスを作成します。
        パラメーター:
        value - キャッシュ制御文字列
        戻り値:
        新しく作成された CacheControl
        例外:
        IllegalArgumentExceptionSE - 指定された文字列を解析できないか、null の場合
      • isMustRevalidate

        public boolean isMustRevalidate()
        検証が必要なキャッシュ制御ディレクティブに対応します。
        戻り値:
        検証が必要なキャッシュ制御ディレクティブがレスポンスに含まれる場合は true、それ以外の場合は false。
        関連事項:
        HTTP/1.1 セクション 14.9.4
      • setMustRevalidate

        public void setMustRevalidate​(boolean mustRevalidate)
        検証が必要なキャッシュ制御ディレクティブに対応します。
        パラメーター:
        mustRevalidate - 検証が必要なキャッシュ制御ディレクティブをレスポンスに含める必要がある場合は true、そうでない場合は false。
        関連事項:
        HTTP/1.1 セクション 14.9.4
      • isProxyRevalidate

        public boolean isProxyRevalidate()
        proxy-revalidate キャッシュ制御ディレクティブに対応します。
        戻り値:
        プロキシ再検証キャッシュ制御ディレクティブがレスポンスに含まれる場合は true、それ以外の場合は false。
        関連事項:
        HTTP/1.1 セクション 14.9.4
      • setProxyRevalidate

        public void setProxyRevalidate​(boolean proxyRevalidate)
        検証が必要なキャッシュ制御ディレクティブに対応します。
        パラメーター:
        proxyRevalidate - プロキシ再検証キャッシュ制御ディレクティブをレスポンスに含める必要がある場合は true、それ以外の場合は false。
        関連事項:
        HTTP/1.1 セクション 14.9.4
      • getMaxAge

        public int getMaxAge()
        max-age キャッシュ制御ディレクティブに対応します。
        戻り値:
        max-age キャッシュ制御ディレクティブの値。ディレクティブが無効になっている場合は -1。
        関連事項:
        HTTP/1.1 セクション 14.9.3
      • setMaxAge

        public void setMaxAge​(int maxAge)
        max-age キャッシュ制御ディレクティブに対応します。
        パラメーター:
        maxAge - max-age キャッシュ制御ディレクティブの値。値が -1 の場合、ディレクティブは無効になります。
        関連事項:
        HTTP/1.1 セクション 14.9.3
      • getSMaxAge

        public int getSMaxAge()
        s-maxage キャッシュ制御ディレクティブに対応します。
        戻り値:
        s-maxage キャッシュ制御ディレクティブの値。ディレクティブが無効になっている場合は -1。
        関連事項:
        HTTP/1.1 セクション 14.9.3
      • setSMaxAge

        public void setSMaxAge​(int smaxAge)
        s-maxage キャッシュ制御ディレクティブに対応します。
        パラメーター:
        smaxAge - s-maxage キャッシュ制御ディレクティブの値。値が -1 の場合、ディレクティブは無効になります。
        関連事項:
        HTTP/1.1 セクション 14.9.3
      • getNoCacheFields

        public ListSE<StringSE> getNoCacheFields()
        キャッシュなしキャッシュ制御ディレクティブの値に対応します。
        戻り値:
        キャッシュなしキャッシュ制御ディレクティブの値を形成するフィールド名の変更可能なリスト。空のリストは、裸のキャッシュなしディレクティブになります。
        関連事項:
        isNoCache(), setNoCache(boolean), HTTP/1.1 セクション 14.9.1
      • setNoCache

        public void setNoCache​(boolean noCache)
        no-cache cachecontrol ディレクティブに対応します。
        パラメーター:
        noCache - キャッシュなしのキャッシュ制御ディレクティブをレスポンスに含める必要がある場合は true、そうでない場合は false。
        関連事項:
        getNoCacheFields(), HTTP/1.1 セクション 14.9.1
      • isNoCache

        public boolean isNoCache()
        no-cache cachecontrol ディレクティブに対応します。
        戻り値:
        キャッシュなしのキャッシュ制御ディレクティブがレスポンスに含まれる場合は true、それ以外の場合は false。
        関連事項:
        getNoCacheFields(), HTTP/1.1 セクション 14.9.1
      • isPrivate

        public boolean isPrivate()
        プライベートキャッシュ制御ディレクティブに対応します。
        戻り値:
        プライベートキャッシュ制御ディレクティブがレスポンスに含まれる場合は true、それ以外の場合は false。
        関連事項:
        getPrivateFields(), HTTP/1.1 セクション 14.9.1
      • getPrivateFields

        public ListSE<StringSE> getPrivateFields()
        プライベートキャッシュ制御ディレクティブの値に対応します。
        戻り値:
        プライベートキャッシュ制御ディレクティブの値を形成するフィールド名の変更可能なリスト。空のリストは、裸のキャッシュなしディレクティブになります。
        関連事項:
        isPrivate(), setPrivate(boolean), HTTP/1.1 セクション 14.9.1
      • setPrivate

        public void setPrivate​(boolean flag)
        プライベートキャッシュ制御ディレクティブに対応します。
        パラメーター:
        flag - プライベートキャッシュ制御ディレクティブをレスポンスに含める必要がある場合は true、そうでない場合は false。
        関連事項:
        getPrivateFields(), HTTP/1.1 セクション 14.9.1
      • isNoTransform

        public boolean isNoTransform()
        no-transform キャッシュ制御ディレクティブに対応します。
        戻り値:
        no-transform キャッシュ制御ディレクティブがレスポンスに含まれる場合は true、それ以外の場合は false。
        関連事項:
        HTTP/1.1 セクション 14.9.5
      • setNoTransform

        public void setNoTransform​(boolean noTransform)
        no-transform キャッシュ制御ディレクティブに対応します。
        パラメーター:
        noTransform - no-transform キャッシュ制御ディレクティブをレスポンスに含める必要がある場合は true、それ以外の場合は false。
        関連事項:
        HTTP/1.1 セクション 14.9.5
      • isNoStore

        public boolean isNoStore()
        no-store キャッシュ制御ディレクティブに対応します。
        戻り値:
        no-store キャッシュ制御ディレクティブがレスポンスに含まれる場合は true、それ以外の場合は false。
        関連事項:
        HTTP/1.1 セクション 14.9.2
      • setNoStore

        public void setNoStore​(boolean noStore)
        no-store キャッシュ制御ディレクティブに対応します。
        パラメーター:
        noStore - no-store cache control ディレクティブをレスポンスに含める必要がある場合は true、それ以外の場合は false。
        関連事項:
        HTTP/1.1 セクション 14.9.2
      • getCacheExtension

        public MapSE<StringSE,​StringSE> getCacheExtension()
        拡張キャッシュ制御ディレクティブのセットに対応します。
        戻り値:
        キャッシュ制御拡張名とその値の可変マップ。キーに null 値がある場合、裸のディレクティブとして表示されます。キーに空白を含まない値がある場合、ディレクティブは単純な名前 = 値のペアとして表示されます。キーに空白を含む値がある場合、ディレクティブは引用符で囲まれた name="value" のペアとして表示されます。
        関連事項:
        HTTP/1.1 セクション 14.9.6
      • toString

        @DeprecatedSE
        public StringSE toString()
        使用すべきではありません。
        toString() メソッドの形式は、将来のバージョンで変更される可能性があります。このメソッドの形式に依存する場合は、代わりに RuntimeDelegate.getInstance()。createHeaderDelegate(CacheControl.class).toString(value)を使用してください。
        キャッシュコントロールを、対応する HTTP ヘッダーの値として使用するのに適した文字列に変換します。
        オーバーライド:
        クラス ObjectSEtoString 
        戻り値:
        ストリング化されたキャッシュ制御
      • hashCode

        public int hashCode()
        キャッシュ制御プロパティからハッシュコードを生成します。
        オーバーライド:
        クラス ObjectSEhashCode 
        戻り値:
        hashCode
      • equals

        public boolean equals​(ObjectSE obj)
        オブジェクト引数をこのキャッシュコントロールと比較して、すべてのプロパティ値を考慮してそれらが同じであるかどうかを確認します。
        オーバーライド:
        クラス ObjectSEequalsSE 
        パラメーター:
        obj - 比較するオブジェクト
        戻り値:
        2 つのキャッシュコントロールが同じ場合は true、それ以外の場合は false。