001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.server.kerberos.shared.messages.value.types;
021    
022    
023    /**
024     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
025     * @version $Rev: 540371 $, $Date: 2007-05-22 02:00:43 +0200 (Tue, 22 May 2007) $
026     */
027    public enum TransitedEncodingType
028    {
029        /**
030         * Constant for the "null" transited encoding type.
031         */
032        NULL( 0 ),
033    
034        /**
035         * Constant for the "Domain X500 compress" transited encoding type.
036         */
037        DOMAIN_X500_COMPRESS( 1 );
038    
039    
040        /**
041         * The value/code for the transited encoding type.
042         */
043        private final int ordinal;
044    
045    
046        /**
047         * Private constructor prevents construction outside of this class.
048         */
049        private TransitedEncodingType( int ordinal )
050        {
051            this.ordinal = ordinal;
052        }
053    
054    
055        /**
056         * Returns the transited encoding type when specified by its ordinal.
057         *
058         * @param type
059         * @return The transited encoding type.
060         */
061        public static TransitedEncodingType getTypeByOrdinal( int type )
062        {
063            switch ( type )
064            {
065                case 1  : return DOMAIN_X500_COMPRESS;
066                default : return NULL;
067            }
068        }
069    
070    
071        /**
072         * Returns the number associated with this transited encoding type.
073         *
074         * @return The transited encoding type ordinal.
075         */
076        public int getOrdinal()
077        {
078            return ordinal;
079        }
080    
081        /**
082         * @see Object#toString()
083         */
084        public String toString()
085        {
086            switch ( this )
087            {
088                case DOMAIN_X500_COMPRESS : return "Domain X500 compress (1)";
089                default :                   return "null (0)";
090            }
091        }
092    }