MultiPartSpecification.java

/*
 * Copyright 2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.restassured.specification;

/**
 * Represents one multi-part
 */
public interface MultiPartSpecification {
    /**
     * @return The content to be sent
     */
    Object getContent();

    /**
     * @return The control name, may be <code>null</code>.
     */
    String getControlName();

    /**
     * @return The mime-type, may be <code>null</code>.
     */
    String getMimeType();

    /**
     * @return The charset, may be <code>null</code>.
     */
    String getCharset();

    /**
     * @return The fileName of the multi-part, may be <code>null</code>.
     */
    String getFileName();

    /**
     * @return <code>true</code> if this multi-part specification contains a filename, <code>false</code> otherwise.
     */
    boolean hasFileName();
}