binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/DataObjectSerializerImplementation.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.dom.codec.impl;
   9
  10 import java.io.IOException;
  11 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
  12 import org.opendaylight.yangtools.yang.binding.DataObject;
  13
  14 /**
  15  * SPI-level contract for implementations of {@link DataObjectSerializer}.
  16  * The contract is kept between implementation of {@link DataObjectSerializerRegistry},
  17  * which maintains the lookup context required for recursive serialization.
  18  */
  19 //* FIXME: this interface should not be necessary
  20 public interface DataObjectSerializerImplementation {
  21     /**
  22      * Writes stream events for supplied data object to provided stream.
  23      *
  24      * <p>
  25      * DataObjectSerializerRegistry may be used to lookup serializers for other generated classes  in order to support
  26      * writing their events.
  27      */
  28     void serialize(DataObjectSerializerRegistry reg, DataObject obj, BindingStreamEventWriter stream)
  29             throws IOException;
  30 }