PropertiesFileRenderer.java |
1 /* 2 * Copyright 2005 Paul Hinds 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 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 */ 16package org.tp23.antinstaller; 17 18import java.io.File; 19/** 20 * 21 * <p>Renders a properties file in the base directory for Ant to use and 22 * available for viewing after for Debug</p> 23 * In earlier versions this was the only way to access properties it is now 24 * mostly redundant. 25 * @author Paul Hinds 26 * @version $Id: PropertiesFileRenderer.java,v 1.4 2006/12/23 04:07:23 teknopaul Exp $ 27 */ 28public interface PropertiesFileRenderer { 29 30 public static final String FILE_ROOT_PROPERTY = "basedir"; 31 public static final String INSTALLER_VERSION_PROPERTY = "ant.install.config.version"; 32 public static final String PROPERTIES_FILE_NAME = "ant.install.properties"; 33 public static final String TARGETS_SUFFIX = "-targets"; 34 35 /** 36 * This method no longer throws IOException since the requirement to print properties 37 * has been removed. By default properties will be printed since they are usefull 38 * for debug but classes implementing this method should swallow all Exceptions 39 * @param ctx InstallerContext 40 * @param baseDir File 41 */ 42 public void renderProperties(InstallerContext ctx, File baseDir); 43} 44