Unmarshallable.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2025 by Tidalwave s.a.s. (http://tidalwave.it)
  8.  *
  9.  * *************************************************************************************************************************************************************
  10.  *
  11.  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
  12.  * You may obtain a copy of the License at
  13.  *
  14.  *     http://www.apache.org/licenses/LICENSE-2.0
  15.  *
  16.  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
  17.  * CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.
  18.  *
  19.  * *************************************************************************************************************************************************************
  20.  *
  21.  * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
  22.  * git clone https://github.com/tidalwave-it/thesefoolishthings-src
  23.  *
  24.  * *************************************************************************************************************************************************************
  25.  */
  26. package it.tidalwave.role.io;

  27. import jakarta.annotation.Nonnull;
  28. import java.io.IOException;
  29. import java.io.InputStream;

  30. /***************************************************************************************************************************************************************
  31.  *
  32.  * The role of an object that can be unmarshalled.
  33.  *
  34.  * @stereotype Role
  35.  *
  36.  * @author  Fabrizio Giudici
  37.  *
  38.  **************************************************************************************************************************************************************/
  39. @FunctionalInterface
  40. public interface Unmarshallable
  41.   {
  42.     public static final Class<Unmarshallable> _Unmarshallable_ = Unmarshallable.class;

  43.     /***********************************************************************************************************************************************************
  44.      * Unmarshalls the object from the given {@link InputStream}.
  45.      * @param  <T>             the type of the returned value
  46.      * @param   is             the {@code InputStream}
  47.      * @return                 the unmarshalled object
  48.      * @throws  IOException    when an error occurs
  49.      **********************************************************************************************************************************************************/
  50.     @SuppressWarnings("RedundantThrows")
  51.     @Nonnull
  52.     public <T> T unmarshal (@Nonnull InputStream is)
  53.       throws IOException;
  54.   }