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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of it-tidalwave-role Show documentation

Roles are a powerful way for designing complex behaviours while keeping good practices such as Single Responsibility, Dependency Inversion and Interface Segregation.

The newest version!

/*
 * *********************************************************************************************************************
 *
 * TheseFoolishThings: Miscellaneous utilities
 * http://tidalwave.it/projects/thesefoolishthings
 *
 * Copyright (C) 2009 - 2023 by Tidalwave s.a.s. (http://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.
 *
 * *********************************************************************************************************************
 *
 * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
 * git clone https://github.com/tidalwave-it/thesefoolishthings-src
 *
 * *********************************************************************************************************************
 */
package it.tidalwave.role;

import javax.annotation.Nonnull;
import java.io.PrintWriter;

/***********************************************************************************************************************
 *
 * The role of an object that can be rendered into a {@link String} as plain text. Note that while it has a method
 * with the same signature as {@link StringRenderable}, it has modified semantics since it guarantees that the returned
 * string is a plain text.
 *
 * @stereotype Role
 *
 * @author  Fabrizio Giudici
 *
 **********************************************************************************************************************/
@FunctionalInterface
public interface PlainTextRenderable extends StringRenderable
  {
    public static final Class _PlainTextRenderable_ = PlainTextRenderable.class;

    /*******************************************************************************************************************
     *
     *
     * @since 3.2-ALPHA-1 (was previously on {@code Feedback8}
     *
     ******************************************************************************************************************/
    public default void renderTo (@Nonnull final StringBuilder stringBuilder,
                                  @Nonnull final Object ... args)
      {
        stringBuilder.append(render(args));
      }

    /*******************************************************************************************************************
     *
     *
     * @since 3.2-ALPHA-1 (was previously on {@code Feedback8}
     *
     ******************************************************************************************************************/
    public default void renderTo (@Nonnull final PrintWriter printWriter,
                                  @Nonnull final Object ... args)
      {
        printWriter.print(render(args));
      }
  }