/*
 * Copyright (c) 2011-2018 The original author or authors
 * ------------------------------------------------------
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 *     The Eclipse Public License is available at
 *     http://www.eclipse.org/legal/epl-v10.html
 *
 *     The Apache License v2.0 is available at
 *     http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.ext.web.multipart;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.ext.web.multipart.impl.MultipartFormImpl;

A multipart form.
Author:Julien Viet
/** * A multipart form. * * @author <a href="mailto:julien@julienviet.com">Julien Viet</a> */
@VertxGen public interface MultipartForm extends Iterable<FormDataPart> {
Returns:a multipart form instance
/** * @return a multipart form instance */
static MultipartForm create() { return new MultipartFormImpl(); }
Add an attribute form data part.
Params:
  • name – the name of the attribute
  • value – the value of the attribute
Returns:a reference to this, so the API can be used fluently
/** * Add an attribute form data part. * * @param name the name of the attribute * @param value the value of the attribute * @return a reference to this, so the API can be used fluently */
@Fluent MultipartForm attribute(String name, String value);
Add a text file upload form data part.
Params:
  • name – name of the parameter
  • filename – filename of the file
  • pathname – the pathname of the file
  • mediaType – the MIME type of the file
Returns:a reference to this, so the API can be used fluently
/** * Add a text file upload form data part. * * @param name name of the parameter * @param filename filename of the file * @param pathname the pathname of the file * @param mediaType the MIME type of the file * @return a reference to this, so the API can be used fluently */
@Fluent MultipartForm textFileUpload(String name, String filename, String pathname, String mediaType);
Add a binary file upload form data part.
Params:
  • name – name of the parameter
  • filename – filename of the file
  • pathname – the pathname of the file
  • mediaType – the MIME type of the file
Returns:a reference to this, so the API can be used fluently
/** * Add a binary file upload form data part. * * @param name name of the parameter * @param filename filename of the file * @param pathname the pathname of the file * @param mediaType the MIME type of the file * @return a reference to this, so the API can be used fluently */
@Fluent MultipartForm binaryFileUpload(String name, String filename, String pathname, String mediaType); }