CharBuffer.h

Go to the documentation of this file.

/*
 * 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_NIO_CHARBUFFER_H_
#define _DECAF_NIO_CHARBUFFER_H_

#include <decaf/nio/Buffer.h>
#include <decaf/lang/Comparable.h>
#include <decaf/lang/exceptions/NullPointerException.h>
#include <decaf/lang/exceptions/IndexOutOfBoundsException.h>
#include <decaf/nio/BufferUnderflowException.h>
#include <decaf/nio/BufferOverflowException.h>
#include <decaf/nio/ReadOnlyBufferException.h>
#include <decaf/lang/CharSequence.h>
#include <decaf/lang/Appendable.h>

namespace decaf{
namespace nio{

    class DECAF_API CharBuffer : public Buffer,
                                 public lang::CharSequence,
                                 public lang::Appendable,
                                 public lang::Comparable<CharBuffer> {
    protected:

        CharBuffer( int capacity );

    public:

        virtual ~CharBuffer() {}

        virtual std::string toString() const;

        CharBuffer& append( char value );

        CharBuffer& append( const lang::CharSequence* value );

        CharBuffer& append( const lang::CharSequence* value, int start, int end );

        virtual char* array() = 0;

        virtual int arrayOffset() = 0;

        virtual CharBuffer* asReadOnlyBuffer() const = 0;

        char charAt( int index ) const;

        virtual CharBuffer& compact() = 0;

        virtual CharBuffer* duplicate() = 0;

        virtual char get() = 0;

        virtual char get( int index ) const = 0;

        CharBuffer& get( std::vector<char> buffer );

        CharBuffer& get( char* buffer, int size, int offset, int length );

        virtual bool hasArray() const = 0;

        int length() const {
            return this->remaining();
        }

        CharBuffer& put( CharBuffer& src );

        CharBuffer& put( const char* buffer, int size, int offset, int length );

        CharBuffer& put( std::vector<char>& buffer );

        virtual CharBuffer& put( char value ) = 0;

        virtual CharBuffer& put( int index, char value ) = 0;

        CharBuffer& put( std::string& src, int start, int end );

        CharBuffer& put( const std::string& src );

        virtual int read( CharBuffer* target );

        virtual lang::CharSequence* subSequence( int start, int end ) const = 0;

        virtual CharBuffer* slice() const = 0;

    public:  // Comparable

        virtual int compareTo( const CharBuffer& value ) const;

        virtual bool equals( const CharBuffer& value ) const;

        virtual bool operator==( const CharBuffer& value ) const;

        virtual bool operator<( const CharBuffer& value ) const;

    public:   // Statics

        static CharBuffer* allocate( int capacity );

        static CharBuffer* wrap( char* array, int size, int offset, int length );

        static CharBuffer* wrap( std::vector<char>& buffer );

// TODO
//        static CharBuffer* wrap( lang::CharSequence* csq, int start, int end );

// TODO
//        static CharBuffer* wrap( lang::CharSequence* csq );

    };

}}

#endif /*_DECAF_NIO_CHARBUFFER_H_*/