com.hcl.domino.misc.INumberEnum Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation

There is a newer version: 1.44.0

/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            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 .
 *
 * 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.
 * ==========================================================================
 */
package com.hcl.domino.misc;

/**
 * This interface describes an enum that is backed by a C-style numeric value
 * enum.
 *
 * @param  the boxed primitive type that backs this enum
 * @author Jesse Gallagher
 */
public interface INumberEnum {
  /**
   * @return the C-level value of the enum as a long
   */
  long getLongValue();

  /**
   * @return the C-level value of the enum
   */
  T getValue();
  
  /**
   * Determines whether the enum value should be skipped by automatic lookup for enum
   * values. For example, this may apply to mask or multi-element values that are
   * nonetheless usefully represented in an enum.
   * 
   * @return {@code true} if automatic matching should skip this entry;
   *         {@code false} otherwise
   * @since 1.0.34
   */
  default boolean isSkipInLookup() {
    return false;
  }
}