TextReadable.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2024 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 javax.annotation.Nonnull;
  28. import java.io.IOException;
  29. import java.io.Reader;

  30. /***************************************************************************************************************************************************************
  31.  *
  32.  * The role of an object that can be read as a stream of characters.
  33.  *
  34.  * @author  Fabrizio Giudici
  35.  * @it.tidalwave.javadoc.stable
  36.  *
  37.  **************************************************************************************************************************************************************/
  38. @FunctionalInterface
  39. public interface TextReadable
  40.   {
  41.     public static final Class<TextReadable> _TextReadable_ = TextReadable.class;

  42.     /***********************************************************************************************************************************************************
  43.      * A default implementation which throws {@link IOException} when opening the stream.
  44.      **********************************************************************************************************************************************************/
  45.     public static final TextReadable DEFAULT = new TextReadable()
  46.       {
  47.         @Override @Nonnull
  48.         public Reader openReader()
  49.           throws IOException
  50.           {
  51.             throw new IOException("Operation not supported");
  52.           }
  53.       };

  54.     /***********************************************************************************************************************************************************
  55.      * Returns a {@link Reader} to read from the object.
  56.      *
  57.      * @return               the {@code Reader}
  58.      * @throws  IOException  if the operation can't be performed
  59.      **********************************************************************************************************************************************************/
  60.     @Nonnull
  61.     public Reader openReader()
  62.       throws IOException;
  63.   }