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.fileupload2.core;
018
019/**
020 * Provides access to headers.
021 *
022 * @param <T> The FileItemHeadersProvider type.
023 * @see FileItem
024 * @see FileItemInput
025 */
026public interface FileItemHeadersProvider<T extends FileItemHeadersProvider<T>> {
027
028    /**
029     * Gets the collection of headers defined locally within this item.
030     *
031     * @return the {@link FileItemHeaders} present for this item.
032     */
033    FileItemHeaders getHeaders();
034
035    /**
036     * Sets the headers read from within an item. Implementations of {@link FileItem} or {@link FileItemInput} should implement this interface to be able to get
037     * the raw headers found within the item header block.
038     *
039     * @param headers the instance that holds onto the headers for this instance.
040     * @return this
041     */
042    T setHeaders(FileItemHeaders headers);
043
044}