Marshallable.java

  1. /*
  2.  * *********************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2023 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
  12.  * the License. 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
  17.  * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
  18.  * specific language governing permissions and limitations under the License.
  19.  *
  20.  * *********************************************************************************************************************
  21.  *
  22.  * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
  23.  * git clone https://github.com/tidalwave-it/thesefoolishthings-src
  24.  *
  25.  * *********************************************************************************************************************
  26.  */
  27. package it.tidalwave.role.io;

  28. import javax.annotation.Nonnull;
  29. import java.io.IOException;
  30. import java.io.OutputStream;

  31. /***********************************************************************************************************************
  32.  *
  33.  * The role of an object that can be marshalled to an {@link OutputStream}.
  34.  *
  35.  * @stereotype Role
  36.  *
  37.  * @author  Fabrizio Giudici
  38.  *
  39.  **********************************************************************************************************************/
  40. @FunctionalInterface
  41. public interface Marshallable
  42.   {
  43.     public static final Class<Marshallable> _Marshallable_ = Marshallable.class;

  44.     /*******************************************************************************************************************
  45.      *
  46.      * Marshals this object to an {@link OutputStream}.
  47.      *
  48.      * @param    os           the {@code OutputStream}
  49.      * @throws   IOException  in case of errors
  50.      *
  51.      ******************************************************************************************************************/
  52.     @SuppressWarnings("RedundantThrows")
  53.     public void marshal (@Nonnull OutputStream os)
  54.       throws IOException;
  55.   }