DoubleBuffer.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_DOUBLEBUFFER_H_
#define _DECAF_NIO_DOUBLEBUFFER_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>

namespace decaf{
namespace nio{

    class DECAF_API DoubleBuffer : public Buffer,
                                   public lang::Comparable<DoubleBuffer> {
    protected:

        DoubleBuffer( int capacity );

    public:

        virtual ~DoubleBuffer() {}

        virtual std::string toString() const;

        virtual double* array() = 0;

        virtual int arrayOffset() = 0;

        virtual DoubleBuffer* asReadOnlyBuffer() const = 0;

        virtual DoubleBuffer& compact() = 0;

        virtual DoubleBuffer* duplicate() = 0;

        virtual double get() = 0;

        virtual double get( int index ) const = 0;

        DoubleBuffer& get( std::vector<double> buffer );

        DoubleBuffer& get( double* buffer, int size, int offset, int length );

        virtual bool hasArray() const = 0;

        DoubleBuffer& put( DoubleBuffer& src );

        DoubleBuffer& put( const double* buffer, int size, int offset, int length );

        DoubleBuffer& put( std::vector<double>& buffer );

        virtual DoubleBuffer& put( double value ) = 0;

        virtual DoubleBuffer& put( int index, double value ) = 0;

        virtual DoubleBuffer* slice() const = 0;

    public:  // Comparable

        virtual int compareTo( const DoubleBuffer& value ) const;

        virtual bool equals( const DoubleBuffer& value ) const;

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

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

    public:   // Statics

        static DoubleBuffer* allocate( int capacity );

        static DoubleBuffer* wrap( double* array, int size, int offset, int length );

        static DoubleBuffer* wrap( std::vector<double>& buffer );

    };

}}

#endif /*_DECAF_NIO_DOUBLEBUFFER_H_*/