/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
#ifndef _DECAF_IO_WRITER_H
#define _DECAF_IO_WRITER_H

#include <string>
#include <vector>
#include <decaf/io/IOException.h>
#include <decaf/io/Closeable.h>
#include <decaf/io/Flushable.h>
#include <decaf/lang/Appendable.h>
#include <decaf/lang/exceptions/NullPointerException.h>
#include <decaf/lang/exceptions/IndexOutOfBoundsException.h>

namespace decaf{
namespace io{

    /*
     * Abstract class for writing to character streams. The only methods that a
     * subclass must implement are write( char*, size_t, size_t ), flush(), and
     * close().  Most subclasses, however, will override some of the methods
     * defined here in order to provide higher efficiency, additional functionality,
     * or both.
     *
     * @since 1.0
     */
    class DECAF_API Writer: public decaf::io::Closeable, public decaf::io::Flushable, public decaf::lang::Appendable {
    private:

        Writer(const Writer&);
        Writer& operator=(const Writer&);

    public:

        Writer();

        virtual ~Writer();

        /**
         * Writes an single byte char value.
         *
         * @param v
         *      The value to be written.
         *
         * @throws IOException thrown if an error occurs.
         */
        virtual void write(char v);

        /**
         * Writes an array of Chars
         *
         * @param buffer
         *      The array to be written.
         *
         * @throws IOException thrown if an error occurs.
         */
        virtual void write(const std::vector<char>& buffer);

        /**
         * Writes a byte array to the output stream.
         *
         * @param buffer
         *      The byte array to write (cannot be NULL).
         * @param size
         *      The size in bytes of the buffer passed.
         *
         * @throws IOException if an I/O error occurs.
         * @throws NullPointerException if buffer is NULL.
         */
        virtual void write(const char* buffer, int size);

        /**
         * Writes a byte array to the output stream.
         *
         * @param buffer
         *      The byte array to write (cannot be NULL).
         * @param size
         *      The size in bytes of the buffer passed.
         * @param offset
         *      The position in the array to start writing from.
         * @param length
         *      The number of bytes in the array to write.
         *
         * @throws IOException if an I/O error occurs.
         * @throws NullPointerException if buffer is NULL.
         * @throws IndexOutOfBoundsException if offset + length > size of the buffer.
         */
        virtual void write(const char* buffer, int size, int offset, int length);

        /**
         * Writes a string
         *
         * @param str
         *      The string to be written.
         *
         * @throws IOException thrown if an error occurs.
         */
        virtual void write(const std::string& str);

        /**
         * Writes a string
         *
         * @param str
         *      The string to be written.
         * @param offset
         *      The position in the array to start writing from.
         * @param length
         *      The number of bytes in the array to write.
         *
         * @throws IOException thrown if an error occurs.
         * @throws IndexOutOfBoundsException if offset+length is greater than the string length.
         */
        virtual void write(const std::string& str, int offset, int length);

        virtual decaf::lang::Appendable& append(char value);

        virtual decaf::lang::Appendable& append(const decaf::lang::CharSequence* csq);

        virtual decaf::lang::Appendable& append(const decaf::lang::CharSequence* csq, int start, int end);

    protected:

        /**
         * Override this method to customize the functionality of the method
         * write( char* buffer, int size, int offset, int length ).
         *
         * All subclasses must override this method to provide the basic Writer
         * functionality.
         */
        virtual void doWriteArrayBounded(const char* buffer, int size, int offset, int length) = 0;

    protected:

        virtual void doWriteChar(char v);

        virtual void doWriteVector(const std::vector<char>& buffer);

        virtual void doWriteArray(const char* buffer, int size);

        virtual void doWriteString(const std::string& str);

        virtual void doWriteStringBounded(const std::string& str, int offset, int length);

        virtual decaf::lang::Appendable& doAppendChar(char value);

        virtual decaf::lang::Appendable& doAppendCharSequence(const decaf::lang::CharSequence* csq);

        virtual decaf::lang::Appendable& doAppendCharSequenceStartEnd(const decaf::lang::CharSequence* csq, int start, int end);

    };

}}

#endif /*_DECAF_IO_WRITER_H*/