ridljar/com/sun/star/uno/Enum.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 package com.sun.star.uno;
  20
  21 /**
  22  * The Enum class is the base class for all classes generated
  23  * as java binding for the IDL type enum.
  24  * <p>
  25  * Each java mapped enum class provides static member of this class
  26  * which represents the enum values.
  27  * You cannot create an object of this class or subclass direct, to
  28  * avoid enum values with integer values outside the defined range.
  29  * </p>
  30  */
  31 public abstract class Enum {
  32     private final int m_value;
  33
  34     /**
  35      * Constructs an enum value.
  36      * @param  value   the integer value of this enum value.
  37      */
  38     protected Enum(int value) {
  39         m_value = value;
  40     }
  41
  42     /**
  43      * Get the integer value of an enum value.
  44      * @return   the integer value.
  45      */
  46     public final int getValue() {
  47         return m_value;
  48     }
  49 }
  50