org.apache.http.impl.cookie

## Class AbstractCookieSpec

- java.lang.Object
- - org.apache.http.impl.cookie.AbstractCookieSpec

- All Implemented Interfaces:
    CookieSpec
  Direct Known Subclasses:
    CookieSpecBase

      @Contract(threading=SAFE)
      public abstract class AbstractCookieSpec
      extends Object
      implements CookieSpec

  Abstract cookie specification which can delegate the job of parsing, validation or matching cookie attributes to a number of arbitrary `CookieAttributeHandler`s.
  Since:
    4.0

- - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `` | `AbstractCookieSpec()` Default constructor
    `protected` | `AbstractCookieSpec(CommonCookieAttributeHandler... handlers)`
    `protected` | `AbstractCookieSpec(HashMap<String,CookieAttributeHandler> map)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected CookieAttributeHandler` | `findAttribHandler(String name)` Finds an attribute handler `CookieAttributeHandler` for the given attribute.
    `protected CookieAttributeHandler` | `getAttribHandler(String name)` Gets attribute handler `CookieAttributeHandler` for the given attribute.
    `protected Collection<CookieAttributeHandler>` | `getAttribHandlers()`
    `void` | `registerAttribHandler(String name, CookieAttributeHandler handler)` Deprecated. (4.4) use `AbstractCookieSpec(java.util.HashMap)` or `AbstractCookieSpec(org.apache.http.cookie.CommonCookieAttributeHandler...)` constructors instead.

    - ### Methods inherited from class java.lang.Object

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

    - ### Methods inherited from interface org.apache.http.cookie.CookieSpec

      `formatCookies, getVersion, getVersionHeader, match, parse, validate`

- - ### Constructor Detail

    - #### AbstractCookieSpec

          public AbstractCookieSpec()

      Default constructor

    - #### AbstractCookieSpec

          protected AbstractCookieSpec(HashMap<String,CookieAttributeHandler> map)

      Since:
        4.4

    - #### AbstractCookieSpec

          protected AbstractCookieSpec(CommonCookieAttributeHandler... handlers)

      Since:
        4.4

  - ### Method Detail

    - #### registerAttribHandler

          @Deprecated
          public void registerAttribHandler(String name,
                                              CookieAttributeHandler handler)

      Deprecated. (4.4) use `AbstractCookieSpec(java.util.HashMap)` or `AbstractCookieSpec(org.apache.http.cookie.CommonCookieAttributeHandler...)` constructors instead.

    - #### findAttribHandler

          protected CookieAttributeHandler findAttribHandler(String name)

      Finds an attribute handler `CookieAttributeHandler` for the given attribute. Returns `null` if no attribute handler is found for the specified attribute.
      Parameters:
        `name` - attribute name. e.g. Domain, Path, etc.
      Returns:
        an attribute handler or `null`

    - #### getAttribHandler

          protected CookieAttributeHandler getAttribHandler(String name)

      Gets attribute handler `CookieAttributeHandler` for the given attribute.
      Parameters:
        `name` - attribute name. e.g. Domain, Path, etc.
      Throws:
        `IllegalStateException` - if handler not found for the specified attribute.

    - #### getAttribHandlers

          protected Collection<CookieAttributeHandler> getAttribHandlers()

Copyright © 1999–2022 The Apache Software Foundation. All rights reserved.