    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 * @see FileItem
    025 * @see FileItemStream
    026 */
    027public interface FileItemHeadersSupport {
    028
    029    /**
    030     * Returns the collection of headers defined locally within this item.
    031     *
    032     * @return the {@link FileItemHeaders} present for this item.
    033     */
    034    FileItemHeaders getHeaders();
    035
    036    /**
    037     * Sets the headers read from within an item.  Implementations of
    038     * {@link FileItem} or {@link FileItemStream} should implement this
    039     * interface to be able to get the raw headers found within the item
    040     * header block.
    041     *
    042     * @param headers the instance that holds onto the headers
    043     *         for this instance.
    044     */
    045    void setHeaders(FileItemHeaders headers);
    046
    047}