KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tomcat > jni > Directory


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 package org.apache.tomcat.jni;
19
20 /** Directory
21  *
22  * @author Mladen Turk
23  * @version $Revision: 467222 $, $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $
24  */
25
26 public class Directory {
27
28     /**
29      * Create a new directory on the file system.
30      * @param path the path for the directory to be created. (use / on all systems)
31      * @param perm Permissions for the new direcoty.
32      * @param pool the pool to use.
33      */
34     public static native int make(String JavaDoc path, int perm, long pool);
35
36     /** Creates a new directory on the file system, but behaves like
37      * 'mkdir -p'. Creates intermediate directories as required. No error
38      * will be reported if PATH already exists.
39      * @param path the path for the directory to be created. (use / on all systems)
40      * @param perm Permissions for the new direcoty.
41      * @param pool the pool to use.
42      */
43     public static native int makeRecursive(String JavaDoc path, int perm, long pool);
44
45     /**
46      * Remove directory from the file system.
47      * @param path the path for the directory to be removed. (use / on all systems)
48      * @param pool the pool to use.
49      */
50     public static native int remove(String JavaDoc path, long pool);
51
52     /**
53      * Find an existing directory suitable as a temporary storage location.
54      * @param pool The pool to use for any necessary allocations.
55      * @return The temp directory.
56      *
57      * This function uses an algorithm to search for a directory that an
58      * an application can use for temporary storage. Once such a
59      * directory is found, that location is cached by the library. Thus,
60      * callers only pay the cost of this algorithm once if that one time
61      * is successful.
62      *
63      */
64     public static native String JavaDoc tempGet(long pool);
65
66     /**
67      * Open the specified directory.
68      * @param dirname The full path to the directory (use / on all systems)
69      * @param pool The pool to use.
70      * @return The opened directory descriptor.
71      */
72     public static native long open(String JavaDoc dirname, long pool)
73         throws Error JavaDoc;
74
75     /**
76      * close the specified directory.
77      * @param thedir the directory descriptor to close.
78      */
79     public static native int close(long thedir);
80
81     /**
82      * Rewind the directory to the first entry.
83      * @param thedir the directory descriptor to rewind.
84      */
85     public static native int rewind(long thedir);
86
87
88     /**
89      * Read the next entry from the specified directory.
90      * @param finfo the file info structure and filled in by apr_dir_read
91      * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values
92      * @param thedir the directory descriptor returned from apr_dir_open
93      * No ordering is guaranteed for the entries read.
94      */
95     public static native int read(FileInfo finfo, int wanted, long thedir);
96
97 }
98
Popular Tags