/*
* 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.types;
import java.util.Iterator;
import java.util.Stack;
import java.util.Vector;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.filters.ChainableReader;
import org.apache.tools.ant.filters.ClassConstants;
import org.apache.tools.ant.filters.EscapeUnicode;
import org.apache.tools.ant.filters.ExpandProperties;
import org.apache.tools.ant.filters.HeadFilter;
import org.apache.tools.ant.filters.LineContains;
import org.apache.tools.ant.filters.LineContainsRegExp;
import org.apache.tools.ant.filters.PrefixLines;
import org.apache.tools.ant.filters.ReplaceTokens;
import org.apache.tools.ant.filters.StripJavaComments;
import org.apache.tools.ant.filters.StripLineBreaks;
import org.apache.tools.ant.filters.StripLineComments;
import org.apache.tools.ant.filters.SuffixLines;
import org.apache.tools.ant.filters.TabsToSpaces;
import org.apache.tools.ant.filters.TailFilter;
import org.apache.tools.ant.filters.TokenFilter;
/**
* FilterChain may contain a chained set of filter readers.
*
*/
public class FilterChain extends DataType {
private Vector<Object> filterReaders = new Vector<Object>();
/**
* Add an AntFilterReader filter.
*
* @param filterReader an <code>AntFilterReader</code> value
*/
public void addFilterReader(final AntFilterReader filterReader) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(filterReader);
}
/**
* Return the filters.
*
* @return a <code>Vector</code> value containing the filters
*/
public Vector<Object> getFilterReaders() {
if (isReference()) {
return ((FilterChain) getCheckedRef()).getFilterReaders();
}
dieOnCircularReference();
return filterReaders;
}
/**
* Add a ClassConstants filter.
*
* @param classConstants a <code>ClassConstants</code> value
*/
public void addClassConstants(final ClassConstants classConstants) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(classConstants);
}
/**
* Add an ExpandProperties filter.
*
* @param expandProperties an <code>ExpandProperties</code> value
*/
public void addExpandProperties(final ExpandProperties expandProperties) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(expandProperties);
}
/**
* Add a HeadFilter filter.
*
* @param headFilter a <code>HeadFilter</code> value
*/
public void addHeadFilter(final HeadFilter headFilter) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(headFilter);
}
/**
* Add a LineContains filter.
*
* @param lineContains a <code>LineContains</code> value
*/
public void addLineContains(final LineContains lineContains) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(lineContains);
}
/**
* Add a LineContainsRegExp filter.
*
* @param lineContainsRegExp a <code>LineContainsRegExp</code> value
*/
public void addLineContainsRegExp(final LineContainsRegExp
lineContainsRegExp) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(lineContainsRegExp);
}
/**
* Add a PrefixLines filter.
*
* @param prefixLines a <code>PrefixLines</code> value
*/
public void addPrefixLines(final PrefixLines prefixLines) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(prefixLines);
}
/**
* Add a SuffixLines filter.
*
* @param suffixLines a <code>SuffixLines</code> value
* @since Ant 1.8.0
*/
public void addSuffixLines(final SuffixLines suffixLines) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(suffixLines);
}
/**
* Add a ReplaceTokens filter.
*
* @param replaceTokens a <code>ReplaceTokens</code> value
*/
public void addReplaceTokens(final ReplaceTokens replaceTokens) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(replaceTokens);
}
/**
* Add a StripJavaCommands filter.
*
* @param stripJavaComments a <code>StripJavaComments</code> value
*/
public void addStripJavaComments(final StripJavaComments
stripJavaComments) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(stripJavaComments);
}
/**
* Add a StripLineBreaks filter.
*
* @param stripLineBreaks a <code>StripLineBreaks</code> value
*/
public void addStripLineBreaks(final StripLineBreaks
stripLineBreaks) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(stripLineBreaks);
}
/**
* Add a StripLineComments filter.
*
* @param stripLineComments a <code>StripLineComments</code> value
*/
public void addStripLineComments(final StripLineComments
stripLineComments) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(stripLineComments);
}
/**
* Add a TabsToSpaces filter.
*
* @param tabsToSpaces a <code>TabsToSpaces</code> value
*/
public void addTabsToSpaces(final TabsToSpaces tabsToSpaces) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(tabsToSpaces);
}
/**
* Add a TailFilter filter.
*
* @param tailFilter a <code>TailFilter</code> value
*/
public void addTailFilter(final TailFilter tailFilter) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(tailFilter);
}
/**
* Add an EscapeUnicode filter.
*
* @param escapeUnicode an <code>EscapeUnicode</code> value
* @since Ant 1.6
*/
public void addEscapeUnicode(final EscapeUnicode escapeUnicode) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(escapeUnicode);
}
/**
* Add a TokenFilter filter.
*
* @param tokenFilter a <code>TokenFilter</code> value
* @since Ant 1.6
*/
public void addTokenFilter(final TokenFilter tokenFilter) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(tokenFilter);
}
/**
* Add a delete characters filter.
*
* @param filter a <code>TokenFilter.DeleteCharacters</code> value
* @since Ant 1.6
*/
public void addDeleteCharacters(TokenFilter.DeleteCharacters filter) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(filter);
}
/**
* Add a containsregex filter.
*
* @param filter a <code>TokenFilter.ContainsRegex</code> value
* @since Ant 1.6
*/
public void addContainsRegex(TokenFilter.ContainsRegex filter) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(filter);
}
/**
* Add a replaceregex filter.
*
* @param filter a <code>TokenFilter.ReplaceRegex</code> value
*/
public void addReplaceRegex(TokenFilter.ReplaceRegex filter) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(filter);
}
/**
* Add a trim filter.
*
* @param filter a <code>TokenFilter.Trim</code> value
* @since Ant 1.6
*/
public void addTrim(TokenFilter.Trim filter) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(filter);
}
/**
* Add a replacestring filter.
*
* @param filter a <code>TokenFilter.ReplaceString</code> value
* @since Ant 1.6
*/
public void addReplaceString(
TokenFilter.ReplaceString filter) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(filter);
}
/**
* Add an ignoreBlank filter.
*
* @param filter a <code>TokenFilter.IgnoreBlank</code> value
* @since Ant 1.6
*/
public void addIgnoreBlank(
TokenFilter.IgnoreBlank filter) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(filter);
}
/**
* Makes this instance in effect a reference to another FilterChain
* instance.
*
* <p>You must not set another attribute or nest elements inside
* this element if you make it a reference.</p>
*
* @param r the reference to which this instance is associated
* @exception BuildException if this instance already has been configured.
*/
@Override
public void setRefid(Reference r) throws BuildException {
if (!filterReaders.isEmpty()) {
throw tooManyAttributes();
}
super.setRefid(r);
}
/**
* Add a chainfilter filter.
*
* @param filter a <code>ChainableReader</code> value
* @since Ant 1.6
*/
public void add(ChainableReader filter) {
if (isReference()) {
throw noChildrenAllowed();
}
setChecked(false);
filterReaders.addElement(filter);
}
@Override
protected synchronized void dieOnCircularReference(Stack<Object> stk, Project p)
throws BuildException {
if (isChecked()) {
return;
}
if (isReference()) {
super.dieOnCircularReference(stk, p);
} else {
for (Iterator<Object> i = filterReaders.iterator(); i.hasNext();) {
Object o = i.next();
if (o instanceof DataType) {
pushAndInvokeCircularReferenceCheck((DataType) o, stk, p);
}
}
setChecked(true);
}
}
}