View Javadoc
1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.hc.client5.http.entity.mime;
29  
30  import org.apache.hc.core5.util.Args;
31  
32  /**
33   * FormBodyPart class represents a content body that can be used as a part of multipart encoded
34   * entities. This class automatically populates the header with standard fields based on
35   * the content description of the enclosed body.
36   *
37   * @since 4.0
38   */
39  public class FormBodyPart extends MultipartPart {
40  
41      private final String name;
42  
43      FormBodyPart(final String name, final ContentBody body, final Header header) {
44          super(body, header);
45          Args.notNull(name, "Name");
46          Args.notNull(body, "Body");
47          this.name = name;
48      }
49  
50      public String getName() {
51          return this.name;
52      }
53  
54      @Override
55      public void addField(final String name, final String value) {
56          Args.notNull(name, "Field name");
57          super.addField(name, value);
58      }
59  
60  }