1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.fileupload2.core;
18
19 /**
20 * Provides access to headers.
21 *
22 * @param <T> The FileItemHeadersProvider type.
23 * @see FileItem
24 * @see FileItemInput
25 */
26 public interface FileItemHeadersProvider<T extends FileItemHeadersProvider<T>> {
27
28 /**
29 * Gets the collection of headers defined locally within this item.
30 *
31 * @return the {@link FileItemHeaders} present for this item.
32 */
33 FileItemHeaders getHeaders();
34
35 /**
36 * Sets the headers read from within an item. Implementations of {@link FileItem} or {@link FileItemInput} should implement this interface to be able to get
37 * the raw headers found within the item header block.
38 *
39 * @param headers the instance that holds onto the headers for this instance.
40 * @return this
41 */
42 T setHeaders(FileItemHeaders headers);
43
44 }