View Javadoc

1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package org.jboss.netty.handler.ipfilter;
17  
18  import java.net.InetAddress;
19  
20  /** This Interface defines an IpSet object. */
21  public interface IpSet {
22      /**
23       * Compares the given InetAddress against the IpSet and returns true if
24       * the InetAddress is contained in this Rule and false if not.
25       *
26       * @return returns true if the given IP address is contained in the current
27       *         IpSet.
28       */
29      boolean contains(InetAddress inetAddress1);
30  }