org.eclipse.angus.mail.iap.Literal Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1997, 2023 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.eclipse.angus.mail.iap;

import java.io.IOException;
import java.io.OutputStream;

/**
 * An interface for objects that provide data dynamically for use in
 * a literal protocol element.
 *
 * @author Bill Shannon
 */

public interface Literal {
    /**
     * Return the size of the data.
     *
     * @return the size of the data
     */
    public int size();

    /**
     * Write the data to the OutputStream.
     *
     * @param    os    the output stream
     * @exception IOException    for I/O errors
     */
    public void writeTo(OutputStream os) throws IOException;
}