de.schlichtherle.truezip.socket.OutputService Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2005-2015 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */
package de.schlichtherle.truezip.socket;

import de.schlichtherle.truezip.entry.Entry;
import de.schlichtherle.truezip.entry.EntryContainer;
import java.util.Iterator;

/**
 * A service for output sockets.
 * 
 * All methods of this interface must reflect all entries, including those
 * which have only been partially written yet, i.e. which have not already
 * received a call to their {@code close()} method.
 *
 * @param    the type of the entries.
 * @see     InputService
 * @author  Christian Schlichtherle
 */
public interface OutputService extends EntryContainer {

    /**
     * {@inheritDoc}
     * 
     * The iterator returned by this method must be unmodifiable.
     */
    @Override
    Iterator iterator();

    /**
     * Returns an output socket for writing to the given entry.
     *
     * @param  entry the entry, which will be the
     *         {@link OutputSocket#getLocalTarget local target} of the returned
     *         output socket.
     * @return An output socket for writing to the given entry.
     */
    // TODO: This should return OutputSocket.
    OutputSocket getOutputSocket(E entry);
}