| /* |
| * 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 |
| * |
| * https://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.filters; |
| |
| import java.io.IOException; |
| import java.io.Reader; |
| import java.util.Vector; |
| |
| import org.apache.tools.ant.Project; |
| import org.apache.tools.ant.types.Parameter; |
| |
| /** |
| * Filter which includes only those lines that contain the user-specified |
| * strings. |
| * |
| * Example: |
| * |
| * <pre><linecontains> |
| * <contains value="foo"> |
| * <contains value="bar"> |
| * </linecontains></pre> |
| * |
| * Or: |
| * |
| * <pre><filterreader classname="org.apache.tools.ant.filters.LineContains"> |
| * <param type="contains" value="foo"/> |
| * <param type="contains" value="bar"/> |
| * </filterreader></pre> |
| * |
| * This will include only those lines that contain <code>foo</code> and |
| * <code>bar</code>. |
| * |
| * Starting Ant 1.10.4, the {@code matchAny} attribute can be used to control whether any one |
| * of the user-specified strings is expected to be contained in the line or all |
| * of them are expected to be contained. |
| * |
| * For example: |
| * |
| * <pre><linecontains matchAny="true"> |
| * * <contains value="foo"> |
| * * <contains value="bar"> |
| * * </linecontains></pre> |
| * |
| * This will include only those lines that contain either <code>foo</code> or <code>bar</code>. |
| * |
| */ |
| public final class LineContains |
| extends BaseParamFilterReader |
| implements ChainableReader { |
| /** Parameter name for the words to filter on. */ |
| private static final String CONTAINS_KEY = "contains"; |
| |
| /** Parameter name for the words to filter on. */ |
| private static final String NEGATE_KEY = "negate"; |
| |
| /** Vector that holds the strings that input lines must contain. */ |
| private Vector<String> contains = new Vector<>(); |
| |
| /** |
| * Remaining line to be read from this filter, or <code>null</code> if |
| * the next call to <code>read()</code> should read the original stream |
| * to find the next matching line. |
| */ |
| private String line = null; |
| |
| private boolean negate = false; |
| |
| private boolean matchAny = false; |
| |
| /** |
| * Constructor for "dummy" instances. |
| * |
| * @see BaseFilterReader#BaseFilterReader() |
| */ |
| public LineContains() { |
| super(); |
| } |
| |
| /** |
| * Creates a new filtered reader. |
| * |
| * @param in A Reader object providing the underlying stream. |
| * Must not be <code>null</code>. |
| */ |
| public LineContains(final Reader in) { |
| super(in); |
| } |
| |
| /** |
| * Returns the next character in the filtered stream, only including |
| * lines from the original stream which contain all of the specified words. |
| * |
| * @return the next character in the resulting stream, or -1 |
| * if the end of the resulting stream has been reached |
| * |
| * @exception IOException if the underlying stream throws an IOException |
| * during reading |
| */ |
| public int read() throws IOException { |
| if (!getInitialized()) { |
| initialize(); |
| setInitialized(true); |
| } |
| |
| int ch = -1; |
| |
| if (line != null) { |
| ch = line.charAt(0); |
| if (line.length() == 1) { |
| line = null; |
| } else { |
| line = line.substring(1); |
| } |
| } else { |
| final int containsSize = contains.size(); |
| |
| for (line = readLine(); line != null; line = readLine()) { |
| boolean matches = true; |
| for (int i = 0; i < containsSize; i++) { |
| final String containsStr = contains.elementAt(i); |
| matches = line.contains(containsStr); |
| if (!matches) { |
| if (this.matchAny) { |
| // this one didn't match, but we are expected to have |
| // any one of them match. so try next |
| continue; |
| } else { |
| // all were expected to match, but this one didn't. |
| // so no point checking the rest |
| break; |
| } |
| } else if (this.matchAny) { |
| // we were expected to match any of the contains |
| // and this one did. so no more checks needed |
| break; |
| } |
| } |
| if (matches ^ isNegated()) { |
| break; |
| } |
| } |
| if (line != null) { |
| return read(); |
| } |
| } |
| return ch; |
| } |
| |
| /** |
| * Adds a <code>contains</code> element. |
| * |
| * @param contains The <code>contains</code> element to add. |
| * Must not be <code>null</code>. |
| */ |
| public void addConfiguredContains(final Contains contains) { |
| this.contains.addElement(contains.getValue()); |
| } |
| |
| /** |
| * Set the negation mode. Default false (no negation). |
| * @param b the boolean negation mode to set. |
| */ |
| public void setNegate(boolean b) { |
| negate = b; |
| } |
| |
| /** |
| * Find out whether we have been negated. |
| * @return boolean negation flag. |
| */ |
| public boolean isNegated() { |
| return negate; |
| } |
| |
| /** |
| * |
| * @param matchAny True if this {@link LineContains} is considered a match, |
| * if {@code any} of the {@code contains} value match. False |
| * if {@code all} of the {@code contains} value are expected |
| * to match |
| * @since Ant 1.10.4 |
| * |
| */ |
| public void setMatchAny(final boolean matchAny) { |
| this.matchAny = matchAny; |
| } |
| |
| /** |
| * @return Returns true if this {@link LineContains} is considered a match, |
| * if {@code any} of the {@code contains} value match. False |
| * if {@code all} of the {@code contains} value are expected |
| * to match |
| * |
| * @since Ant 1.10.4 |
| */ |
| public boolean isMatchAny() { |
| return this.matchAny; |
| } |
| |
| /** |
| * Sets the vector of words which must be contained within a line read |
| * from the original stream in order for it to match this filter. |
| * |
| * @param contains A vector of words which must be contained within a line |
| * in order for it to match in this filter. Must not be <code>null</code>. |
| */ |
| private void setContains(final Vector<String> contains) { |
| this.contains = contains; |
| } |
| |
| /** |
| * Returns the vector of words which must be contained within a line read |
| * from the original stream in order for it to match this filter. |
| * |
| * @return the vector of words which must be contained within a line read |
| * from the original stream in order for it to match this filter. The |
| * returned object is "live" - in other words, changes made to the |
| * returned object are mirrored in the filter. |
| */ |
| private Vector<String> getContains() { |
| return contains; |
| } |
| |
| /** |
| * Creates a new LineContains using the passed in |
| * Reader for instantiation. |
| * |
| * @param rdr A Reader object providing the underlying stream. |
| * Must not be <code>null</code>. |
| * |
| * @return a new filter based on this configuration, but filtering |
| * the specified reader |
| */ |
| public Reader chain(final Reader rdr) { |
| LineContains newFilter = new LineContains(rdr); |
| newFilter.setContains(getContains()); |
| newFilter.setNegate(isNegated()); |
| newFilter.setMatchAny(isMatchAny()); |
| return newFilter; |
| } |
| |
| /** |
| * Parses the parameters to add user-defined contains strings. |
| */ |
| private void initialize() { |
| Parameter[] params = getParameters(); |
| if (params != null) { |
| for (Parameter param : params) { |
| if (CONTAINS_KEY.equals(param.getType())) { |
| contains.addElement(param.getValue()); |
| } else if (NEGATE_KEY.equals(param.getType())) { |
| setNegate(Project.toBoolean(param.getValue())); |
| } |
| } |
| } |
| } |
| |
| /** |
| * Holds a contains element |
| */ |
| public static class Contains { |
| |
| /** User defined contains string */ |
| private String value; |
| |
| /** |
| * Sets the contains string |
| * |
| * @param contains The contains string to set. |
| * Must not be <code>null</code>. |
| */ |
| public final void setValue(String contains) { |
| value = contains; |
| } |
| |
| /** |
| * Returns the contains string. |
| * |
| * @return the contains string for this element |
| */ |
| public final String getValue() { |
| return value; |
| } |
| } |
| } |