gerrit.onap Code Review - dcaegen2/services/sdk.git/blob

   1 /*
   2  * ============LICENSE_START====================================
   3  * DCAEGEN2-SERVICES-SDK
   4  * =========================================================
   5  * Copyright (C) 2019 Nokia. All rights reserved.
   6  * =========================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *       http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=====================================
  19  */
  20
  21 package org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.streams;
  22
  23 import io.vavr.control.Either;
  24 import io.vavr.control.Try;
  25 import org.onap.dcaegen2.services.sdk.rest.services.annotations.ExperimentalApi;
  26 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.exceptions.StreamParserError;
  27 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.exceptions.StreamParsingException;
  28 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.streams.DataStream;
  29 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.streams.RawDataStream;
  30
  31 /**
  32  * A generic data stream parser which parses {@code T} to data stream {@code S}.
  33  *
  34  * @author <a href="mailto:piotr.jaszczyk@nokia.com">Piotr Jaszczyk</a>
  35  * @param <T> input data type, eg. Gson Object
  36  * @param <S> output data type
  37  * @since 1.1.4
  38  */
  39 @ExperimentalApi
  40 public interface StreamParser<T, S extends DataStream> {
  41
  42     /**
  43      * Parse the input data {@code T} producing the {@link DataStream}.
  44      *
  45      * @param input - the input data
  46      * @return Right(parsing result) or Left(parsing error)
  47      */
  48     default Either<StreamParserError, S> parse(RawDataStream<T> input) {
  49         return Try.of(() -> unsafeParse(input))
  50                 .toEither()
  51                 .mapLeft(StreamParserError::fromThrowable);
  52     }
  53
  54     /**
  55      * Parse the input data {@code T} producing the {@link DataStream}. Will throw StreamParsingException when input
  56      * was invalid.
  57      *
  58      * @param input - the input data
  59      * @return parsing result
  60      * @throws StreamParsingException when parsing was unsuccessful
  61      */
  62     default S unsafeParse(RawDataStream<T> input) {
  63         return parse(input).getOrElseThrow(StreamParsingException::new);
  64     }
  65 }