/**
*
* Copyright (c) 2006-2017, Speedment, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); You may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
/*
* To change this license header, choose License Headers in Project Properties.
* To change this template file, choose Tools | Templates
* and open the template in the editor.
*/
package com.speedment.runtime.field.predicate;
/**
* Determines if a range of results should be start and/or end-inclusive.
* <p>
* For an example, take the series {@code [1 2 3 4 5]}. If we select the range
* {@code (2, 4)} from this series, we will get the following results:
* <table summary="Example of inclusion and exclusion">
* <thead>
* <tr>
* <th>Enum Constant</th>
* <th>Included Elements</th>
* </tr>
* </thead>
* <tbody>
* <tr>
* <td>{@link #START_INCLUSIVE_END_INCLUSIVE}</td>
* <td>{@code [2, 3, 4]}</td>
* </tr>
* <tr>
* <td>{@link #START_INCLUSIVE_END_EXCLUSIVE}</td>
* <td>{@code [2, 3]}</td>
* </tr>
* <tr>
* <td>{@link #START_EXCLUSIVE_END_INCLUSIVE}</td>
* <td>{@code [3, 4]}</td>
* </tr>
* <tr>
* <td>{@link #START_EXCLUSIVE_END_EXCLUSIVE}</td>
* <td>{@code [3]}</td>
* </tr>
* </tbody>
* </table>
*
* @author Per Minborg
* @author Emil Forslund
* @since 2.2.0
*/
public enum Inclusion {
START_INCLUSIVE_END_INCLUSIVE(true, true),
START_INCLUSIVE_END_EXCLUSIVE(true, false),
START_EXCLUSIVE_END_INCLUSIVE(false, true),
START_EXCLUSIVE_END_EXCLUSIVE(false, false);
private final boolean startInclusive, endInclusive;
Inclusion(boolean startInclusive, boolean endInclusive) {
this.startInclusive = startInclusive;
this.endInclusive = endInclusive;
}
/**
* Returns {@code true} if the first element in the range should be
* included, else {@code false}.
*
* @return {@code true} if start is included, else {@code false}
*/
public boolean isStartInclusive() {
return startInclusive;
}
/**
* Returns {@code true} if the last element in the range should be
* included, else {@code false}.
*
* @return {@code true} if end is included, else {@code false}
*/
public boolean isEndInclusive() {
return endInclusive;
}
}