Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
file.h
Go to the documentation of this file.
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_FILE_H
19#define _LOG4CXX_FILE_H
20
21#include <log4cxx/logger.h>
22#include <log4cxx/logstring.h>
23
24extern "C" {
25 struct apr_file_t;
26 struct apr_finfo_t;
27}
28
29namespace LOG4CXX_NS
30{
31namespace helpers
32{
33class Transcoder;
34}
35
39class LOG4CXX_EXPORT File
40{
41 public:
50 File(const char* path);
55 File(const std::string& path);
56#if LOG4CXX_WCHAR_T_API
61 File(const wchar_t* path);
66 File(const std::wstring& path);
67#endif
68#if LOG4CXX_CFSTRING_API
73 File(const CFStringRef& path);
74#endif
78 File(const File& src);
82 File& operator=(const File& src);
87
92 bool hasPath() const;
97 bool exists() const;
102 size_t length() const;
107 log4cxx_time_t lastModified() const;
122 const char* getAPRPath() const;
126 File& setPath(const LogString& newVAlue);
127
128
133 std::vector<LogString> list() const;
134
139 bool deleteFile() const;
145 bool renameTo(const File& dest) const;
146
156 bool mkdirs() const;
157
162 void setAutoDelete(bool newValue);
163
170 bool getAutoDelete() const;
171
172 private:
173 LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(FilePrivate, m_priv)
174};
175} // namespace log4cxx
176
177#define LOG4CXX_FILE(name) File(name)
178
179#endif // _LOG4CXX_FILE_H
File(const wchar_t *path)
Construct a new instance.
bool getAutoDelete() const
Provides the value of the autodelete setting.
bool deleteFile() const
Delete this file.
LogString getName() const
Provides the final portion of file path.
std::vector< LogString > list() const
List files if current file is a directory.
File & operator=(const File &src)
Assignment operator.
LogString getParent() const
Provides the path of parent directory.
bool mkdirs() const
Create the directories required for this file path.
File & setPath(const LogString &newVAlue)
Use newValue as the file path.
~File()
Destructor.
File(const CFStringRef &path)
Construct a new instance.
File(const std::wstring &path)
Construct a new instance.
const char * getAPRPath() const
Provides the file path.
bool exists() const
Determines if file exists.
File(const File &src)
Copy constructor.
File()
Construct a new instance.
bool renameTo(const File &dest) const
Rename this file.
File(const std::string &path)
Construct a new instance.
log4cxx_time_t lastModified() const
Provides the last modification date.
size_t length() const
Provides the length of the file.
File(const char *path)
Construct a new instance.
LogString getPath() const
Provides the file path.
bool hasPath() const
Has a path been set?
void setAutoDelete(bool newValue)
Use newValue for whether the file is to be deleted when this object is destroyed.
const struct __CFString * CFStringRef
Definition logstring.h:30
std::basic_string< logchar > LogString
Definition logstring.h:51