01: /*
02: * Copyright 2005 Paul Hinds
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.tp23.antinstaller;
17:
18: import java.io.File;
19:
20: /**
21: *
22: * <p>Renders a properties file in the base directory for Ant to use and
23: * available for viewing after for Debug</p>
24: * In earlier versions this was the only way to access properties it is now
25: * mostly redundant.
26: * @author Paul Hinds
27: * @version $Id: PropertiesFileRenderer.java,v 1.4 2006/12/23 04:07:23 teknopaul Exp $
28: */
29: public interface PropertiesFileRenderer {
30:
31: public static final String FILE_ROOT_PROPERTY = "basedir";
32: public static final String INSTALLER_VERSION_PROPERTY = "ant.install.config.version";
33: public static final String PROPERTIES_FILE_NAME = "ant.install.properties";
34: public static final String TARGETS_SUFFIX = "-targets";
35:
36: /**
37: * This method no longer throws IOException since the requirement to print properties
38: * has been removed. By default properties will be printed since they are usefull
39: * for debug but classes implementing this method should swallow all Exceptions
40: * @param ctx InstallerContext
41: * @param baseDir File
42: */
43: public void renderProperties(InstallerContext ctx, File baseDir);
44: }
|