Package io.lighty.codecs.api

Interface Serializer<BA extends org.opendaylight.yangtools.yang.binding.DataObject>

  • Type Parameters:
    BA - Binding Aware object type of data, RPC data or Notification data
    All Known Subinterfaces:
    Codec<BA>
    All Known Implementing Classes:
    DataCodec
    public interface Serializer<BA extends org.opendaylight.yangtools.yang.binding.DataObject>
    This class serializes Binding Independent (DOM) objects TO Binding Aware (BA) objects.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Collection<BA> convertBindingAwareList​(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier, org.opendaylight.yangtools.yang.data.api.schema.MapNode mapNode)
      Serialize the Binding Independent MapNode into Binding Aware data list.
      org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier convertIdentifier​(String identifier)  
      BA convertToBindingAwareData​(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?> data)
      Serialize Binding Independent data TO Binding Aware data.
      BA convertToBindingAwareNotification​(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode norificationData)
      Serialize Binding Independent Notification data TO Binding Aware Notification data.
      BA convertToBindingAwareRpc​(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode rpcData)
      Serialize Binding Independent RPC data (input/output) TO Binding Aware RPC data (input/output).
      org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?> serializeXMLError​(String body)
      Serialize restconf error to Normalized Node.

    • Method Detail

      • convertIdentifier

        org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier convertIdentifier​(String identifier)

      • convertToBindingAwareData

        BA convertToBindingAwareData​(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier,
                             org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?> data)
        Serialize Binding Independent data TO Binding Aware data.
        Parameters:
        identifier - identifier of Binding Independent data
        data - Binding Independent data to be serialized
        Returns:
        serialized Binding Aware data

      • convertBindingAwareList

        Collection<BA> convertBindingAwareList​(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier identifier,
                                       org.opendaylight.yangtools.yang.data.api.schema.MapNode mapNode)
        Serialize the Binding Independent MapNode into Binding Aware data list.
        Parameters:
        identifier - identifier of Binding Independent data
        mapNode - Binding Independent data to be serialized
        Returns:
        DataObject collection.

      • serializeXMLError

        org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?> serializeXMLError​(String body)
        Serialize restconf error to Normalized Node.
        Parameters:
        body - restconf error input data
        Returns:
        normalized node of the restconf error

      • convertToBindingAwareRpc

        BA convertToBindingAwareRpc​(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath,
                            org.opendaylight.yangtools.yang.data.api.schema.ContainerNode rpcData)
        Serialize Binding Independent RPC data (input/output) TO Binding Aware RPC data (input/output).
        Parameters:
        schemaPath - - schema path of RPC
        rpcData - - Binding Independent RPC data to be serialized
        Returns:
        serialized Binding Aware RPC data

      • convertToBindingAwareNotification

        BA convertToBindingAwareNotification​(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath,
                                     org.opendaylight.yangtools.yang.data.api.schema.ContainerNode norificationData)
        Serialize Binding Independent Notification data TO Binding Aware Notification data.
        Parameters:
        schemaPath - schema path of Notification
        norificationData - Binding Independent Notification data to be serialized
        Returns:
        serialized Binding Aware Notification data