WriteCursor.java

/* Copyright 2015 The jeo project. All rights reserved.
 *
 * 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.jeo.data;

import java.io.IOException;

/**
 * Interface to be implemented by {@link Cursor} that provide write access.
 * <p>
 * Usage:
 * <pre>
 *     SomeCursor c = ...;
 *     SomeObject x = c.next();
 *     // modify x
 *     c.write();
 *     c.close();
 * </pre>
 * </p>
 */
public interface WriteCursor {

    /**
     * Writes the object previously returned by {@link Cursor#next()}.
     */
    WriteCursor write() throws IOException;

    /**
     * Removes the object previously returned by {@link Cursor#next()}.
     */
    WriteCursor remove() throws IOException;
}