Package io.lighty.codecs

Class DataCodec<T extends org.opendaylight.yangtools.yang.binding.DataObject>

  • All Implemented Interfaces:
    Codec<T>, Deserializer<T>, Serializer<T>
    @Deprecated(forRemoval=true)
public class DataCodec<T extends org.opendaylight.yangtools.yang.binding.DataObject>
extends Object
implements Codec<T>
    Deprecated, for removal: This API element is subject to removal in a future version.
    DataCodec is marked as deprecated because it can be replaced by direct implementation of BindingNormalizedNodeSerializer and NodeConverter.
    DataCodec.

    • Constructor Summary

      Constructors 
      Constructor Description
      DataCodec​(org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices codecServices)
      Deprecated, for removal: This API element is subject to removal in a future version.
       

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      Collection<T> convertBindingAwareList​(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier, org.opendaylight.yangtools.yang.data.api.schema.MapNode mapNode)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Serialize the Binding Independent MapNode into Binding Aware data list.
      org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier convertIdentifier​(String identifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      @Nullable T convertToBindingAwareData​(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?> data)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Serialize Binding Independent data TO Binding Aware data.
      T convertToBindingAwareNotification​(org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute absolute, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode norificationData)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Serialize Binding Independent Notification data TO Binding Aware Notification data.
      T convertToBindingAwareRpc​(org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute absolute, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode rpcData)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Serialize Binding Independent RPC data (input/output) TO Binding Aware RPC data (input/output).
      org.opendaylight.yangtools.yang.data.api.schema.ContainerNode convertToBindingIndependentNotification​(org.opendaylight.yangtools.yang.binding.Notification notificationData)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deserialize Binding Independent Notification data(input/output) FROM Binding Aware Notification data(input/output).
      org.opendaylight.yangtools.yang.data.api.schema.ContainerNode convertToBindingIndependentRpc​(org.opendaylight.yangtools.yang.binding.DataContainer rpcData)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deserialize Binding Independent RPC data(input/output) FROM Binding Aware RPC data(input/output).
      Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,​org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?>> convertToNormalizedNode​(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> identifier, T data)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deserialize Binding Independent data FROM Binding Aware data.
      org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier deserializeIdentifier​(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> identifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deserialize Binding Independent identifier FROM Binding Aware identifier.
      String deserializeIdentifier​(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer getCodec()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get used codec.
      org.opendaylight.yangtools.yang.model.api.EffectiveModelContext getEffectiveModelContext()
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?> serializeXMLError​(String body)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Serialize restconf error to Normalized Node.
      NodeConverter withJson()
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      NodeConverter withXml()
      Deprecated, for removal: This API element is subject to removal in a future version.
       

    • Constructor Detail

      • DataCodec

        public DataCodec​(org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices codecServices)
        Deprecated, for removal: This API element is subject to removal in a future version.

    • Method Detail

      • convertToBindingAwareData

        public @Nullable T convertToBindingAwareData​(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier,
                                             org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?> data)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: Serializer
        Serialize Binding Independent data TO Binding Aware data.
        Specified by:
        convertToBindingAwareData in interface Serializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>
        Parameters:
        identifier - identifier of Binding Independent data
        data - Binding Independent data to be serialized
        Returns:
        serialized Binding Aware data

      • convertBindingAwareList

        public Collection<T> convertBindingAwareList​(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier,
                                             org.opendaylight.yangtools.yang.data.api.schema.MapNode mapNode)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: Serializer
        Serialize the Binding Independent MapNode into Binding Aware data list.
        Specified by:
        convertBindingAwareList in interface Serializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>
        Parameters:
        identifier - identifier of Binding Independent data
        mapNode - Binding Independent data to be serialized
        Returns:
        DataObject collection.

      • deserializeIdentifier

        public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier deserializeIdentifier​(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> identifier)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: Deserializer
        Deserialize Binding Independent identifier FROM Binding Aware identifier.
        Specified by:
        deserializeIdentifier in interface Deserializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>
        Parameters:
        identifier - Binding Aware identifier to be deserialized
        Returns:
        deserialized Binding Independent identifier

      • deserializeIdentifier

        public String deserializeIdentifier​(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        deserializeIdentifier in interface Deserializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>

      • convertIdentifier

        public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier convertIdentifier​(String identifier)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        convertIdentifier in interface Serializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>

      • convertToNormalizedNode

        public Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,​org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?>> convertToNormalizedNode​(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> identifier,
                                                                                                                                                                                          T data)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: Deserializer
        Deserialize Binding Independent data FROM Binding Aware data.
        Specified by:
        convertToNormalizedNode in interface Deserializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>
        Parameters:
        identifier - Identifier of Binding Aware data
        data - Binding Aware data to be deserialized
        Returns:
        deserialized Binding Independent data with Binding Independent identifier wrapped in Map.Entry

      • convertToBindingAwareRpc

        public T convertToBindingAwareRpc​(org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute absolute,
                                  org.opendaylight.yangtools.yang.data.api.schema.ContainerNode rpcData)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: Serializer
        Serialize Binding Independent RPC data (input/output) TO Binding Aware RPC data (input/output).
        Specified by:
        convertToBindingAwareRpc in interface Serializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>
        Parameters:
        absolute - - schema path of RPC
        rpcData - - Binding Independent RPC data to be serialized
        Returns:
        serialized Binding Aware RPC data

      • convertToBindingAwareNotification

        public T convertToBindingAwareNotification​(org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute absolute,
                                           org.opendaylight.yangtools.yang.data.api.schema.ContainerNode norificationData)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: Serializer
        Serialize Binding Independent Notification data TO Binding Aware Notification data.
        Specified by:
        convertToBindingAwareNotification in interface Serializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>
        Parameters:
        absolute - schema path of Notification
        norificationData - Binding Independent Notification data to be serialized
        Returns:
        serialized Binding Aware Notification data

      • convertToBindingIndependentRpc

        public org.opendaylight.yangtools.yang.data.api.schema.ContainerNode convertToBindingIndependentRpc​(org.opendaylight.yangtools.yang.binding.DataContainer rpcData)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: Deserializer
        Deserialize Binding Independent RPC data(input/output) FROM Binding Aware RPC data(input/output).
        Specified by:
        convertToBindingIndependentRpc in interface Deserializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>
        Parameters:
        rpcData - Binding Aware RPC data to be deserialized
        Returns:
        deserialized Binding Independent RPC data

      • convertToBindingIndependentNotification

        public org.opendaylight.yangtools.yang.data.api.schema.ContainerNode convertToBindingIndependentNotification​(org.opendaylight.yangtools.yang.binding.Notification notificationData)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: Deserializer
        Deserialize Binding Independent Notification data(input/output) FROM Binding Aware Notification data(input/output).
        Specified by:
        convertToBindingIndependentNotification in interface Deserializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>
        Parameters:
        notificationData - Binding Aware Notification data to be deserialized
        Returns:
        deserialized Binding Independent Notification data

      • serializeXMLError

        public org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?> serializeXMLError​(String body)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: Serializer
        Serialize restconf error to Normalized Node.
        Specified by:
        serializeXMLError in interface Serializer<T extends org.opendaylight.yangtools.yang.binding.DataObject>
        Parameters:
        body - restconf error input data
        Returns:
        normalized node of the restconf error

      • getCodec

        public org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer getCodec()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: Codec
        Get used codec.
        Specified by:
        getCodec in interface Codec<T extends org.opendaylight.yangtools.yang.binding.DataObject>
        Returns:
        codec

      • getEffectiveModelContext

        public org.opendaylight.yangtools.yang.model.api.EffectiveModelContext getEffectiveModelContext()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getEffectiveModelContext in interface Codec<T extends org.opendaylight.yangtools.yang.binding.DataObject>

      • withJson

        public NodeConverter withJson()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        withJson in interface Codec<T extends org.opendaylight.yangtools.yang.binding.DataObject>

      • withXml

        public NodeConverter withXml()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        withXml in interface Codec<T extends org.opendaylight.yangtools.yang.binding.DataObject>