org.apache.tools.ant.util.GlobPatternMapper Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.util;
import org.apache.tools.ant.BuildException;
/**
* Implementation of FileNameMapper that does simple wildcard pattern
* replacements.
*
* This does simple translations like *.foo -> *.bar where the
* prefix to .foo will be left unchanged. It only handles a single *
* character, use regular expressions for more complicated
* situations.
*
* This is one of the more useful Mappers, it is used by javac for
* example.
*
*/
public class GlobPatternMapper implements FileNameMapper {
// CheckStyle:VisibilityModifier OFF - bc
/**
* Part of "from" pattern before the *.
*/
protected String fromPrefix = null;
/**
* Part of "from" pattern after the *.
*/
protected String fromPostfix = null;
/**
* Length of the prefix ("from" pattern).
*/
protected int prefixLength;
/**
* Length of the postfix ("from" pattern).
*/
protected int postfixLength;
/**
* Part of "to" pattern before the *.
*/
protected String toPrefix = null;
/**
* Part of "to" pattern after the *.
*/
protected String toPostfix = null;
// CheckStyle:VisibilityModifier ON
private boolean fromContainsStar = false;
private boolean toContainsStar = false;
private boolean handleDirSep = false;
private boolean caseSensitive = true;
/**
* Attribute specifying whether to ignore the difference
* between / and \ (the two common directory characters).
* @param handleDirSep a boolean, default is false.
* @since Ant 1.6.3
*/
public void setHandleDirSep(boolean handleDirSep) {
this.handleDirSep = handleDirSep;
}
/**
* Attribute specifying whether to ignore the difference
* between / and \ (the two common directory characters).
* @since Ant 1.8.3
*/
public boolean getHandleDirSep() {
return handleDirSep;
}
/**
* Attribute specifying whether to ignore the case difference
* in the names.
*
* @param caseSensitive a boolean, default is false.
* @since Ant 1.6.3
*/
public void setCaseSensitive(boolean caseSensitive) {
this.caseSensitive = caseSensitive;
}
/**
* Sets the "from" pattern. Required.
* @param from a string
*/
public void setFrom(String from) {
if (from != null) {
int index = from.lastIndexOf("*");
if (index == -1) {
fromPrefix = from;
fromPostfix = "";
} else {
fromPrefix = from.substring(0, index);
fromPostfix = from.substring(index + 1);
fromContainsStar = true;
}
prefixLength = fromPrefix.length();
postfixLength = fromPostfix.length();
} else {
throw new BuildException("this mapper requires a 'from' attribute");
}
}
/**
* Sets the "to" pattern. Required.
* @param to a string
*/
public void setTo(String to) {
if (to != null) {
int index = to.lastIndexOf("*");
if (index == -1) {
toPrefix = to;
toPostfix = "";
} else {
toPrefix = to.substring(0, index);
toPostfix = to.substring(index + 1);
toContainsStar = true;
}
} else {
throw new BuildException("this mapper requires a 'to' attribute");
}
}
/**
* Returns null if the source file name doesn't match the
* "from" pattern, an one-element array containing the
* translated file otherwise.
* @param sourceFileName the filename to map
* @return a list of converted filenames
*/
public String[] mapFileName(String sourceFileName) {
String modName = modifyName(sourceFileName);
if (fromPrefix == null
|| (sourceFileName.length() < (prefixLength + postfixLength))
|| (!fromContainsStar
&& !modName.equals(modifyName(fromPrefix))
)
|| (fromContainsStar
&& (!modName.startsWith(modifyName(fromPrefix))
|| !modName.endsWith(modifyName(fromPostfix)))
)
) {
return null;
}
return new String[] {toPrefix
+ (toContainsStar
? extractVariablePart(sourceFileName)
+ toPostfix
: "")};
}
/**
* Returns the part of the given string that matches the * in the
* "from" pattern.
* @param name the source file name
* @return the variable part of the name
*/
protected String extractVariablePart(String name) {
return name.substring(prefixLength,
name.length() - postfixLength);
}
/**
* modify string based on dir char mapping and case sensitivity
* @param name the name to convert
* @return the converted name
*/
private String modifyName(String name) {
if (!caseSensitive) {
name = name.toLowerCase();
}
if (handleDirSep) {
if (name.indexOf('\\') != -1) {
name = name.replace('\\', '/');
}
}
return name;
}
}