View Javadoc
1   /*
2    * Copyright 2016 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    *   https://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 io.netty.util;
17  
18  /**
19   * Represents a supplier of {@code boolean}-valued results.
20   */
21  public interface BooleanSupplier {
22      /**
23       * Gets a boolean value.
24       * @return a boolean value.
25       * @throws Exception If an exception occurs.
26       */
27      boolean get() throws Exception;
28  
29      /**
30       * A supplier which always returns {@code false} and never throws.
31       */
32      BooleanSupplier FALSE_SUPPLIER = new BooleanSupplier() {
33          @Override
34          public boolean get() {
35              return false;
36          }
37      };
38  
39      /**
40       * A supplier which always returns {@code true} and never throws.
41       */
42      BooleanSupplier TRUE_SUPPLIER = new BooleanSupplier() {
43          @Override
44          public boolean get() {
45              return true;
46          }
47      };
48  }