org.opendaylight.yangtools.concepts.WritableObject Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of yangtools-docs Show documentation

YANG Tools documentation

There is a newer version: 14.0.4

/*
 * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.concepts;

import java.io.DataOutput;
import java.io.IOException;
import org.eclipse.jdt.annotation.NonNullByDefault;

/**
 * Marker interface for an object which can be written out to an {@link DataOutput}. Classes implementing this
 * interface should declare a corresponding
 *
 *  *   {@code public static CLASS readFrom(DataInput in) throws IOException;}
 * 
 *
 * 
 * The serialization format provided by this abstraction does not guarantee versioning. Callers are responsible
 * for ensuring the source stream is correctly positioned. Various utility method for implementing the desired
 * serialization format are available in {@link WritableObjects}.
 */
@NonNullByDefault
public interface WritableObject {
    /**
     * Serialize this object into a {@link DataOutput} as a fixed-format stream.
     *
     * @param out Data output
     * @throws IOException if an I/O error occurs
     * @throws NullPointerException if {@code out} is {@code null}
     */
    void writeTo(DataOutput out) throws IOException;
}