    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.io.output;
    018
    019import java.io.IOException;
    020import java.io.OutputStream;
    021
    022/**
    023 * OutputStream implementation that writes the data to an {@link Appendable}
    024 * Object.
    025 * <p>
    026 * For example, can be used with any {@link java.io.Writer} or a {@link java.lang.StringBuilder}
    027 * or {@link java.lang.StringBuffer}.
    028 * </p>
    029 *
    030 * @since 2.5
    031 * @see java.lang.Appendable
    032 *
    033 * @param <T> The type of the {@link Appendable} wrapped by this AppendableOutputStream.
    034 */
    035public class AppendableOutputStream <T extends Appendable> extends OutputStream {
    036
    037    private final T appendable;
    038
    039    /**
    040     * Construct a new instance with the specified appendable.
    041     *
    042     * @param appendable the appendable to write to
    043     */
    044    public AppendableOutputStream(final T appendable) {
    045        this.appendable = appendable;
    046    }
    047
    048    /**
    049     * Write a character to the underlying appendable.
    050     *
    051     * @param b the character to write
    052     * @throws IOException upon error
    053     */
    054    @Override
    055    public void write(final int b) throws IOException {
    056        appendable.append((char)b);
    057    }
    058
    059    /**
    060     * Return the target appendable.
    061     *
    062     * @return the target appendable
    063     */
    064    public T getAppendable() {
    065        return appendable;
    066    }
    067
    068}