io.netty.handler.codec.http.multipart.InterfaceHttpData Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 The Netty Project
 *
 * The Netty Project licenses this file to you 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:
 *
 *   https://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.netty.handler.codec.http.multipart;

import io.netty.util.ReferenceCounted;

/**
 * Interface for all Objects that could be encoded/decoded using HttpPostRequestEncoder/Decoder
 */
public interface InterfaceHttpData extends Comparable, ReferenceCounted {
    enum HttpDataType {
        Attribute, FileUpload, InternalAttribute
    }

    /**
     * Returns the name of this InterfaceHttpData.
     */
    String getName();

    /**
     *
     * @return The HttpDataType
     */
    HttpDataType getHttpDataType();

    @Override
    InterfaceHttpData retain();

    @Override
    InterfaceHttpData retain(int increment);

    @Override
    InterfaceHttpData touch();

    @Override
    InterfaceHttpData touch(Object hint);
}