/*

 * 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 _LOG4CXX_HELPERS_OUTPUTSTREAM_H

#define _LOG4CXX_HELPERS_OUTPUTSTREAM_H

#include <log4cxx/helpers/object.h>

namespace LOG4CXX_NS

{

namespace helpers

{

class ByteBuffer;

/**

*   Abstract class for writing to character streams.

*/

class LOG4CXX_EXPORT OutputStream : public Object

{

  public:

    DECLARE_ABSTRACT_LOG4CXX_OBJECT(OutputStream)

    BEGIN_LOG4CXX_CAST_MAP()

    LOG4CXX_CAST_ENTRY(OutputStream)

    END_LOG4CXX_CAST_MAP()

  protected:

    OutputStream();

    virtual ~OutputStream();

  public:

    virtual void close() = 0;

    virtual void flush() = 0;

    virtual void write(ByteBuffer& buf) = 0;

    /**

    @deprecated The \c pool parameter is not used and will be removed in a future version.

    */

    [[deprecated("Use close() without a Pool parameter instead")]]

    void close(Pool& p);

    /**

    @deprecated The \c pool parameter is not used and will be removed in a future version.

    */

    [[deprecated("Use flush() without a Pool parameter instead")]]

    void flush(Pool& p);

    /**

    @deprecated The \c pool parameter is not used and will be removed in a future version.

    */

    [[deprecated("Use write() without a Pool parameter instead")]]

    void write(ByteBuffer& buf, Pool& p);

  private:

    OutputStream(const OutputStream&);

    OutputStream& operator=(const OutputStream&);

};

LOG4CXX_PTR_DEF(OutputStream);

} // namespace helpers

}  //namespace log4cxx

#endif //_LOG4CXX_HELPERS_OUTPUTSTREAM_H