View Javadoc
1   /*
2    * Copyright (C) 2011 The Guava Authors
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5    * in compliance with the License. You may obtain a copy of the License at
6    *
7    * http://www.apache.org/licenses/LICENSE-2.0
8    *
9    * Unless required by applicable law or agreed to in writing, software distributed under the License
10   * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11   * or implied. See the License for the specific language governing permissions and limitations under
12   * the License.
13   */
14  
15  package com.google.common.collect;
16  
17  import com.google.common.annotations.GwtCompatible;
18  
19  /**
20   * Indicates whether an endpoint of some range is contained in the range itself ("closed") or not
21   * ("open"). If a range is unbounded on a side, it is neither open nor closed on that side; the
22   * bound simply does not exist.
23   *
24   * @since 10.0
25   */
26  @GwtCompatible
27  public enum BoundType {
28    /**
29     * The endpoint value <i>is not</i> considered part of the set ("exclusive").
30     */
31    OPEN(false),
32    CLOSED(true);
33  
34    final boolean inclusive;
35  
36    BoundType(boolean inclusive) {
37      this.inclusive = inclusive;
38    }
39  
40    /**
41     * Returns the bound type corresponding to a boolean value for inclusivity.
42     */
43    static BoundType forBoolean(boolean inclusive) {
44      return inclusive ? CLOSED : OPEN;
45    }
46  
47    BoundType flip() {
48      return forBoolean(!inclusive);
49    }
50  }