KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > barracuda > taskdefs > DummyXmlcUtils


1 /*
2  * Copyright (C) 2003 Christian Cryder [christianc@granitepeaks.com]
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * $Id: DummyXmlcUtils.java,v 1.7 2004/02/01 05:16:33 christianc Exp $
19  */
20 package org.enhydra.barracuda.taskdefs;
21
22 // import java specifics
23 import java.io.File JavaDoc;
24
25 import org.enhydra.xml.xmlc.taskdef.*;
26
27 /**
28  * Dummy implementation of XmlcUtils for use in testing
29  *
30  */
31 public class DummyXmlcUtils extends XmlcUtils {
32
33     //===========================================================================
34 // QUERY METHODS
35 //===========================================================================
36
37     /**
38      * Get a list of options files for the specified directory.
39      * This method will search for the default options file name
40      * (options.xmlc) in the specified directory and the user.dir
41      * directory as well. It will return them in that order.
42      *
43      * @param theDirectory
44      * The directory to look in for the options file.
45      * @return An array of options files with absolute paths.
46      * An empty array if none found.
47      */
48     public String JavaDoc[] getOptionFiles( File JavaDoc theDirectory ) {
49         return null;
50     }
51
52     /**
53      * Get a list of options files for the specified directory,
54      * having the specified name. This method will search for the
55      * specified options file name and the default options file name
56      * (options.xmlc) in the specified directory and the user.dir
57      * directory as well. It will return them in that order.
58      *
59      * @param theDirectory
60      * The directory to look in for the options file.
61      * @param theOptionsFileName
62      * The name of the options file to look for.
63      * @return An array of options files with absolute paths.
64      * An empty array if none found.
65      */
66     public String JavaDoc[] getOptionFiles( File JavaDoc theDirectory, String JavaDoc theOptionsFileName ) {
67         return null;
68     }
69
70     /**
71      * Get a list of options files for the specified directory,
72      * having the specified names. This method will search for the
73      * specified options file names and the default options file name
74      * (options.xmlc) in the specified directory and the user.dir
75      * directory as well. It will return them in that order.
76      *
77      * @param theDirectory
78      * The directory to look in for the options file.
79      * @param theOptionsFileNames
80      * The list of names of the options file to look for.
81      * @return An array of options files with absolute paths.
82      * An empty array if none found.
83      */
84     public String JavaDoc[] getOptionFiles( File JavaDoc theDirectory, String JavaDoc[] theOptionsFileNames ) {
85         return null;
86     }
87
88     /**
89      * Get a list of options files for the specified directories,
90      * having the specified name. This method will search for the
91      * specified options file name and the default options file name
92      * (options.xmlc) in the specified directories and the user.dir
93      * directory as well. It will return them in that order.
94      *
95      * @param theDirectories
96      * The list of directories to look in for the options files.
97      * @param theOptionsFileName
98      * The name of the options file to look for.
99      * @return An array of options files with absolute paths.
100      * An empty array if none found.
101      */
102     public String JavaDoc[] getOptionFiles( File JavaDoc[] theDirectories, String JavaDoc theOptionsFileName ) {
103         return null;
104     }
105
106     /**
107      * Get a list of options files for the specified directories,
108      * having the specified names. This method will search for the
109      * specified options file names and the default options file name
110      * (options.xmlc) in the specified directories and the user.dir
111      * directory as well. It will return them in that order.
112      *
113      * @param theDirectories
114      * The list of directories to look in for the options files.
115      * @param theOptionsFileNames
116      * The list of names of the options file to look for.
117      * @return An array of options files with absolute paths.
118      * An empty array if none found.
119      */
120     public String JavaDoc[] getOptionFiles( File JavaDoc[] theDirectories, String JavaDoc[] theOptionsFileNames ) {
121         return null;
122     }
123
124     /**
125      * Build a full base file name (i.e. with no file type) out of
126      * the specified components.
127      *
128      * Note that any directory prefix on the theBaseFileName file is stripped before
129      * thePackageDir is applied. So that the following call :
130      *
131      * buildFullBaseFileName( "a.b.c", "foo/resources", "config/test.html" );
132      *
133      * will return a string of "a/b/c/foo/resources/test"
134      *
135      * and this call :
136      *
137      * buildFullBaseFileName( "a.b.c", "", "config/test.html" );
138      *
139      * will return a string of "a/b/c/config/test"
140      *
141      * @param thePackageName
142      * The name of the package to prepend to the file name.
143      * This should be specified using the Java naming convention
144      * i.e. org.enhydra.xmlc
145      * @param thePackageDir
146      * The name of the directory to prepend to the file name.
147      * This is a directory path that can be specified using either '/' or '\'
148      * i.e. foo/resources
149      * @param theBaseFileName
150      * The base file name that the preceding strings are prepended to.
151      * @return A string representing the full path resulting from the specified components
152      * with all separators set to '/'
153      */
154     public String JavaDoc buildFullBaseFileName( String JavaDoc thePackageName,
155                                                 String JavaDoc thePackageDir,
156                                                 String JavaDoc theBaseFileName ) {
157         return null;
158     }
159
160     /**
161      * Build a Java class name out of the specified components.
162      *
163      * @param theFullBaseFileName
164      * The full base file name (specified with '/' separators)
165      * and no file type. e.g. "org.enhydra.test"
166      * @param theModifier
167      * The file modifier to append to the class name
168      * e.g. HTML
169      * @return A Java class name string
170      */
171     public String JavaDoc buildClassName( String JavaDoc theFullBaseFileName,
172                                          String JavaDoc theModifier ) {
173         return null;
174     }
175
176 }
177
178
Popular Tags