com.phloc.web.fileupload.IFileItemHeaders Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.phloc.web.fileupload;

import java.util.Iterator;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * 
 * This class provides support for accessing the headers for a file or form item
 * that was received within a multipart/form-data POST request.
 * 
 * 
 * @author Michael C. Macaluso
 * @since 1.3
 */
public interface IFileItemHeaders
{
  /**
   * Returns the value of the specified part header as a String. If
   * the part did not include a header of the specified name, this method return
   * null. If there are multiple headers with the same name, this
   * method returns the first header in the item. The header name is case
   * insensitive.
   * 
   * @param name
   *        a String specifying the header name
   * @return a String containing the value of the requested header,
   *         or null if the item does not have a header of that
   *         name
   */
  @Nullable
  String getHeader (@Nonnull String name);

  /**
   * 
   * Returns all the values of the specified item header as an
   * Enumeration of String objects.
   * 
   * 
   * If the item did not include any headers of the specified name, this method
   * returns an empty Enumeration. The header name is case
   * insensitive.
   * 
   * 
   * @param name
   *        a String specifying the header name
   * @return an Enumeration containing the values of the requested
   *         header. If the item does not have any headers of that name, return
   *         an empty Enumeration
   */
  @Nonnull
  Iterator  getHeaders (@Nonnull String name);

  /**
   * 
   * Returns an Enumeration of all the header names.
   * 
   * 
   * If the item did not include any headers of the specified name, this method
   * returns an empty Enumeration. The header name is case
   * insensitive.
   * 
   * 
   * @return an Enumeration containing the values of the requested
   *         header. If the item does not have any headers of that name return
   *         an empty Enumeration
   */
  @Nonnull
  Iterator  getHeaderNames ();
}