xref: /aoo4110/main/ridljar/com/sun/star/uno/Enum.java (revision b1cdbd2c)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 package com.sun.star.uno;
25 
26 /**
27  * The Enum class is the base class for all classes generated
28  * as java binding for the IDL type enum.
29  * Each java mapped enum class provides static member of this class
30  * which represents the enum values.
31  * You cannot create a object of this class or subclass direct, to
32  * avoid enum values with integer values outside the defined range.
33  * <p>
34  * @version 	$Revision: 1.5 $ $ $Date: 2008-04-11 11:11:59 $
35  */
36 public abstract class Enum {
37 	private int m_value;
38 
39     /**
40 	 * Constructs a enum value.
41 	 * <p>
42 	 * @param  value   the integer value of this enum value.
43      */
Enum(int value)44 	protected Enum(int value) {
45 		m_value = value;
46 	}
47 
48     /**
49 	 * Get the integer value of an enum value.
50 	 * <p>
51 	 * @return   the integer value.
52      */
getValue()53 	public final int getValue() {
54 		return m_value;
55 	}
56 }
57 
58