com.googlecode.kevinarpe.papaya.appendable.AbstractSimplifiedAppendable Maven / Gradle / Ivy

Go to download
package com.googlecode.kevinarpe.papaya.appendable;

/*
 * #%L
 * This file is part of Papaya.
 * %%
 * Copyright (C) 2013 - 2014 Kevin Connor ARPE ([email protected])
 * %%
 * Papaya is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * GPL Classpath Exception:
 * This project is subject to the "Classpath" exception as provided in
 * the LICENSE file that accompanied this code.
 * 
 * Papaya is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Papaya.  If not, see .
 * #L%
 */

import com.googlecode.kevinarpe.papaya.annotation.FullyTested;
import com.googlecode.kevinarpe.papaya.argument.ObjectArgs;

import java.io.IOException;

/**
 * Reduces the number of methods required for implementation by interface {@link Appendable}
 * from three to one.  Only {@link #append(CharSequence)} must be implemented by subclasses.
 * 
 * @author Kevin Connor ARPE ([email protected])
 */
@FullyTested
public abstract class AbstractSimplifiedAppendable
implements Appendable {

    /**
     * This method calls {@link #append(CharSequence)}.
     * 
     * {@inheritDoc}
     *
     * @throws NullPointerException
     *         if {@code csq} is {@code null}
     * @throws IndexOutOfBoundsException
     * 

     *     if {@code code} or {@code end} are negative
     *     if {@code end} is greater than {@code length}
     *     if {@code start} is greater than {@code end}
     * 
     */
    @Override
    public final Appendable append(CharSequence csq, int start, int end)
    throws IOException {
        ObjectArgs.checkNotNull(csq, "csq");

        CharSequence csq2 = csq.subSequence(start, end);
        Appendable result = append(csq2);
        return result;
    }

    /**
     * This method calls {@link #append(CharSequence)}.
     * 
     * {@inheritDoc}
     */
    @Override
    public final Appendable append(char c)
    throws IOException {
        String x = String.valueOf(c);
        Appendable result = append(x);
        return result;
    }
}