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