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 1595642 2014-05-18 17:32:08Z jvanzyl $
29 * @since 1.1
30 */
31 public class StateDependencyNodeFilter
32 implements DependencyNodeFilter
33 {
34 // constants --------------------------------------------------------------
35
36 /**
37 * A dependency node filter that only accepts included nodes.
38 */
39 public static final StateDependencyNodeFilter INCLUDED = new StateDependencyNodeFilter( DependencyNode.INCLUDED );
40
41 // fields -----------------------------------------------------------------
42
43 /**
44 * The state of dependency nodes to accept.
45 *
46 * @see DependencyNode
47 */
48 private final int state;
49
50 // constructors -----------------------------------------------------------
51
52 /**
53 * Creates a dependency node filter that only accepts dependency nodes of the specified state.
54 *
55 * @param state the state of dependency nodes to accept
56 * @throws IllegalArgumentException if the specified state is invalid
57 */
58 public StateDependencyNodeFilter( int state )
59 {
60 if ( state < DependencyNode.INCLUDED || state > DependencyNode.OMITTED_FOR_CYCLE )
61 {
62 throw new IllegalArgumentException( "Unknown state: " + state );
63 }
64
65 this.state = state;
66 }
67
68 // DependencyNodeFilter methods -------------------------------------------
69
70 /**
71 * {@inheritDoc}
72 */
73 public boolean accept( DependencyNode node )
74 {
75 return node.getState() == state;
76 }
77
78 // public methods ---------------------------------------------------------
79
80 /**
81 * Gets the dependency node state that this filter accepts.
82 *
83 * @return the dependency node state that this filter accepts
84 */
85 public int getState()
86 {
87 return state;
88 }
89 }