View Javadoc
1   /*
2    * junixsocket
3    *
4    * Copyright 2009-2024 Christian Kohlschütter
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * 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, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.newsclub.net.unix;
19  
20  import java.io.IOException;
21  import java.net.SocketAddress;
22  
23  /**
24   * A filter that takes a {@link SocketAddress}, and potentially changes it, or throws an exception
25   * if certain criteria are met.
26   *
27   * @author Christian Kohlschütter
28   */
29  @FunctionalInterface
30  public interface SocketAddressFilter {
31  
32    /**
33     * Applies the filter on the given address.
34     *
35     * @param address The address.
36     * @return The address itself or a changed address.
37     * @throws IOException on error or if a certain error condition is desired.
38     */
39    SocketAddress apply(SocketAddress address) throws IOException;
40  }