001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau;
014
015/**
016 * Defines extended language-specific metadata associated with a class.
017 *
018 * <p>
019 * Serializers and parsers can implement their own language-specific metadata on a class and retrieve the metadata
020 * using the {@link ClassMeta#getExtendedMeta(Class)} method.
021 */
022public class ClassMetaExtended {
023
024   private final ClassMeta<?> cm;
025
026   /**
027    * Constructor.
028    *
029    * @param cm The metadata of the class we're extending.
030    * @throws BeanRuntimeException If any error occurred trying to construct the metadata.
031    */
032   public ClassMetaExtended(ClassMeta<?> cm) throws BeanRuntimeException {
033      this.cm = cm;
034   }
035
036   /**
037    * Returns the class metadata that was passed into the constructor.
038    *
039    * @return The class metadata that was passed into the constructor.
040    */
041   protected ClassMeta<?> getClassMeta() {
042      return cm;
043   }
044
045   /**
046    * Convenience method for calling {@link ClassMeta#getInnerClass()} on the metadata passed to the constructor.
047    *
048    * @return The class wrapped by this metadata.
049    */
050   protected Class<?> getInnerClass() {
051      return cm.getInnerClass();
052   }
053}