it.tidalwave.role.TextWritable Maven / Gradle / Ivy

Go to download
/***********************************************************************************************************************
 *
 * These Foolish Things - Miscellaneous utilities
 * Copyright (C) 2009-2011 by Tidalwave s.a.s. (http://www.tidalwave.it)
 *
 ***********************************************************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 CONDITIONS OF ANY KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations under the License.
 *
 ***********************************************************************************************************************
 *
 * WWW: http://thesefoolishthings.kenai.com
 * SCM: https://kenai.com/hg/thesefoolishthings~src
 *
 **********************************************************************************************************************/
package it.tidalwave.role;

import javax.annotation.Nonnull;
import java.io.IOException;
import java.io.Writer;

/***********************************************************************************************************************
 * 
 * The role of an object that can be written as a stream of characters.
 * 
 * @author  Fabrizio Giudici
 * @version $Id$
 * @it.tidalwave.javadoc.stable
 *
 **********************************************************************************************************************/
public interface TextWritable 
  {
    //@bluebook-begin other
    public final static Class TextWritable = TextWritable.class;
    
    /*******************************************************************************************************************
     *
     * A default implementation which throws {@link IOException} when opening the stream.
     * 
     ******************************************************************************************************************/
    public final static TextWritable DEFAULT = new TextWritable() 
      {
        @Override @Nonnull
        public Writer openWriter() 
          throws IOException 
          {
            throw new IOException("Operation not supported");
          }
      };
    
    //@bluebook-end other
    /*******************************************************************************************************************
     *
     * Returns a {@link Writer} to write into the object.
     * 
     * @return               the {@code Writer}
     * @throws  IOException  if the operation can't be performed
     * 
     ******************************************************************************************************************/
    @Nonnull
    public Writer openWriter()
      throws IOException;
  }