coherence/io/pof/RawDate.hpp

/*
* RawDate.hpp
*
* Copyright (c) 2000, 2009, Oracle and/or its affiliates. All rights reserved.
*
* Oracle is a registered trademarks of Oracle Corporation and/or its
* affiliates.
*
* This software is the confidential and proprietary information of Oracle
* Corporation. You shall not disclose such confidential and proprietary
* information and shall use it only in accordance with the terms of the
* license agreement you entered into with Oracle.
*
* This notice may not be removed or altered.
*/
#ifndef COH_RAW_DATE_HPP
#define COH_RAW_DATE_HPP

#include "coherence/lang.ns"

#include <ostream>
#include <time.h>

COH_OPEN_NAMESPACE3(coherence,io,pof)


/**
* Raw immutable POF date value.
*
* @author jh  2008.04.08
*/
class COH_EXPORT RawDate
    : public cloneable_spec<RawDate>
    {
    friend class factory<RawDate>;

    // ----- typedefs -------------------------------------------------------

    public:
        /**
        * The boxed native type.
        */
        typedef struct tm BoxedType;


    // ----- constructors ---------------------------------------------------

    protected:
        /**
        * Construct a raw POF date value.
        *
        * @param nYear   the year number as defined by ISO8601
        * @param nMonth  the month number between 1 and 12 inclusive as
        *                defined by ISO8601
        * @param nDay    the day number between 1 and 31 inclusive as defined
        *                by ISO8601
        *
        * @return the new RawDate
        */
        RawDate(int32_t nYear, int32_t nMonth, int32_t nDay);

        /**
        * Construct a raw POF date value from a POSIX datetime struct.
        */
        RawDate(const struct tm& timeinfo);

        /**
        * Copy constructor.
        */
        RawDate(const RawDate& that);


    // ----- Object interface -----------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual bool equals(Object::View v) const;

        /**
        * {@inheritDoc}
        */
        virtual size32_t hashCode() const;

        /**
        * {@inheritDoc}
        */
        virtual bool isImmutable() const;

        /**
        * {@inheritDoc}
        */
        virtual void toStream(std::ostream &out) const;


    // ----- accessors ------------------------------------------------------

    public:
        /**
        * Determine the date's year value.
        *
        * @return the year number as defined by ISO8601
        */
        virtual int32_t getYear() const;

        /**
        * Determine the date's month value.
        *
        * @return the month number between 1 and 12 inclusive as defined by
        *         ISO8601
        */
        virtual int32_t getMonth() const;

        /**
        * Determine the date's day value.
        *
        * @return the day number between 1 and 31 inclusive as defined by
        *         ISO8601
        */
        virtual int32_t getDay() const;

        /**
        * Convert the RawDate to a POSIX datetime struct.
        */
        virtual operator struct tm() const;

    // ----- data members ---------------------------------------------------

    protected:
        /**
        * The year number.
        */
        int32_t m_nYear;

        /**
        * The month number.
        */
        int32_t m_nMonth;

        /**
        * The day number.
        */
        int32_t m_nDay;
    };

COH_CLOSE_NAMESPACE3

#endif // COH_RAW_DATE_HPP

Copyright (c) 2000, 2009, Oracle and/or its affiliates. All rights reserved.