1 | /*
|
---|
2 | * Licensed to the Apache Software Foundation (ASF) under one or more
|
---|
3 | * contributor license agreements. See the NOTICE file distributed with
|
---|
4 | * this work for additional information regarding copyright ownership.
|
---|
5 | * The ASF licenses this file to You under the Apache License, Version 2.0
|
---|
6 | * (the "License"); you may not use this file except in compliance with
|
---|
7 | * the License. You may obtain a copy of the License at
|
---|
8 | *
|
---|
9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 | *
|
---|
11 | * Unless required by applicable law or agreed to in writing, software
|
---|
12 | * distributed under the License is distributed on an "AS IS" BASIS,
|
---|
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
14 | * See the License for the specific language governing permissions and
|
---|
15 | * limitations under the License.
|
---|
16 | */
|
---|
17 |
|
---|
18 | #ifndef _LOG4CXX_HELPERS_DATE_FORMAT_H
|
---|
19 | #define _LOG4CXX_HELPERS_DATE_FORMAT_H
|
---|
20 |
|
---|
21 | #include <log4cxx/helpers/timezone.h>
|
---|
22 |
|
---|
23 |
|
---|
24 | namespace log4cxx
|
---|
25 | {
|
---|
26 | namespace helpers
|
---|
27 | {
|
---|
28 |
|
---|
29 | /**
|
---|
30 | * DateFormat is an abstract class for date/time formatting
|
---|
31 | * patterned after java.text.DateFormat.
|
---|
32 | */
|
---|
33 | class LOG4CXX_EXPORT DateFormat : public ObjectImpl {
|
---|
34 | public:
|
---|
35 | DECLARE_ABSTRACT_LOG4CXX_OBJECT(DateFormat)
|
---|
36 | BEGIN_LOG4CXX_CAST_MAP()
|
---|
37 | LOG4CXX_CAST_ENTRY(DateFormat)
|
---|
38 | END_LOG4CXX_CAST_MAP()
|
---|
39 |
|
---|
40 | /**
|
---|
41 | * Destructor
|
---|
42 | */
|
---|
43 | virtual ~DateFormat();
|
---|
44 |
|
---|
45 | /**
|
---|
46 | * Formats an log4cxx_time_t into a date/time string.
|
---|
47 | * @param s string to which the date/time string is appended.
|
---|
48 | * @param tm date to be formatted.
|
---|
49 | * @param p memory pool used during formatting.
|
---|
50 | */
|
---|
51 | virtual void format(LogString &s, log4cxx_time_t tm, log4cxx::helpers::Pool& p) const = 0;
|
---|
52 |
|
---|
53 | /**
|
---|
54 | * Sets the time zone.
|
---|
55 | * @param zone the given new time zone.
|
---|
56 | */
|
---|
57 | virtual void setTimeZone(const TimeZonePtr& zone);
|
---|
58 |
|
---|
59 | /**
|
---|
60 | * Format an integer consistent with the format method.
|
---|
61 | * @param s string to which the numeric string is appended.
|
---|
62 | * @param n integer value.
|
---|
63 | * @param p memory pool used during formatting.
|
---|
64 | * @remarks This method is used by CachedDateFormat to
|
---|
65 | * format the milliseconds.
|
---|
66 | */
|
---|
67 | virtual void numberFormat(LogString& s, int n, log4cxx::helpers::Pool& p) const;
|
---|
68 |
|
---|
69 |
|
---|
70 | protected:
|
---|
71 | /**
|
---|
72 | * Constructor.
|
---|
73 | */
|
---|
74 | DateFormat();
|
---|
75 |
|
---|
76 | private:
|
---|
77 | /**
|
---|
78 | * Copy constructor definition to prevent copying.
|
---|
79 | */
|
---|
80 | DateFormat(const DateFormat&);
|
---|
81 | /**
|
---|
82 | * Assignment definition to prevent assignment.
|
---|
83 | */
|
---|
84 | DateFormat& operator=(const DateFormat&);
|
---|
85 | };
|
---|
86 | LOG4CXX_PTR_DEF(DateFormat);
|
---|
87 |
|
---|
88 |
|
---|
89 | } // namespace helpers
|
---|
90 | } // namespace log4cxx
|
---|
91 |
|
---|
92 | #endif //_LOG4CXX_HELPERS_DATE_FORMAT_H
|
---|