Contents.java

/* The MIT License (MIT)
 *
 * Copyright (c) 2015 Reinventing Geospatial, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.rgi.geopackage.features;

/**
 * It's considered bad practice to have boolean parameters. This enumeration
 * will act as a flag to indicate whether or not a GeoPackageGeometry is empty.
 *
 * @author Luke Lambert
 */
public enum Contents
{
    /**
     * This indicates a non-empty GeoPackage geometry
     */
    NotEmpty((byte)0b00000000),

    /**
     * This indicates an empty GeoPackage geometry
     */
    Empty((byte)0b00010000);

    /**
     * @return the bitMask
     */
    public byte getBitMask()
    {
        return this.bitMask;
    }

    Contents(final byte bitMask)
    {
        this.bitMask = bitMask;
    }

    private final byte bitMask;
}