View Javadoc

1   package org.apache.maven.shared.dependency.tree.filter;
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  import org.apache.maven.shared.dependency.tree.DependencyNode;
23  
24  /**
25   * A dependency node filter that accepts nodes depending on their state.
26   * 
27   * @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
28   * @version $Id: StateDependencyNodeFilter.java 661727 2008-05-30 14:21:49Z bentmann $
29   * @since 1.1
30   */
31  public class StateDependencyNodeFilter implements DependencyNodeFilter
32  {
33      // constants --------------------------------------------------------------
34  
35      /**
36       * A dependency node filter that only accepts included nodes.
37       */
38      public static final StateDependencyNodeFilter INCLUDED = new StateDependencyNodeFilter( DependencyNode.INCLUDED );
39  
40      // fields -----------------------------------------------------------------
41  
42      /**
43       * The state of dependency nodes to accept.
44       * 
45       * @see DependencyNode
46       */
47      private final int state;
48  
49      // constructors -----------------------------------------------------------
50  
51      /**
52       * Creates a dependency node filter that only accepts dependency nodes of the specified state.
53       * 
54       * @param state
55       *            the state of dependency nodes to accept
56       * @throws IllegalArgumentException
57       *             if the specified state is invalid
58       */
59      public StateDependencyNodeFilter( int state )
60      {
61          if ( state < DependencyNode.INCLUDED || state > DependencyNode.OMITTED_FOR_CYCLE )
62          {
63              throw new IllegalArgumentException( "Unknown state: " + state );
64          }
65  
66          this.state = state;
67      }
68  
69      // DependencyNodeFilter methods -------------------------------------------
70  
71      /**
72       * {@inheritDoc}
73       */
74      public boolean accept( DependencyNode node )
75      {
76          return node.getState() == state;
77      }
78  
79      // public methods ---------------------------------------------------------
80  
81      /**
82       * Gets the dependency node state that this filter accepts.
83       * 
84       * @return the dependency node state that this filter accepts
85       */
86      public int getState()
87      {
88          return state;
89      }
90  }