    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.fileupload;
    018
    019/**
    020 * Interface that will indicate that {@link FileItem} or {@link FileItemStream}
    021 * implementations will accept the headers read for the item.
    022 *
    023 * @since 1.2.1
    024 *
    025 * @see FileItem
    026 * @see FileItemStream
    027 */
    028public interface FileItemHeadersSupport {
    029
    030    /**
    031     * Returns the collection of headers defined locally within this item.
    032     *
    033     * @return the {@link FileItemHeaders} present for this item.
    034     */
    035    FileItemHeaders getHeaders();
    036
    037    /**
    038     * Sets the headers read from within an item.  Implementations of
    039     * {@link FileItem} or {@link FileItemStream} should implement this
    040     * interface to be able to get the raw headers found within the item
    041     * header block.
    042     *
    043     * @param headers the instance that holds onto the headers
    044     *         for this instance.
    045     */
    046    void setHeaders(FileItemHeaders headers);
    047
    048}