View Javadoc
1   package org.apache.maven.shared.artifact.filter.resolve;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /**
23   * The element interface of the visitor pattern for transforming filters.
24   *
25   * @author Robert Scholte
26   * @since 3.0
27   */
28  public interface TransformableFilter
29  {
30      /**
31       * Subclasses should include the following code:
32       * <pre>
33       *   &#64;Override
34       *   public abstract &lt;T&gt; T transform( FilterTransformer&lt;T&gt; transformer )
35       *   {
36       *       return transformer.transform( this );
37       *   }
38       * </pre>
39       *
40       * @param <T> the interface of the tool specific filter
41       * @param transformer the tool specific transformer, may not be {@code null}
42       * @return the transformed value, never {@code null}
43       */
44      <T> T transform( FilterTransformer<T> transformer );
45  }