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.json;
014
015import static org.apache.juneau.common.internal.StringUtils.*;
016
017import org.apache.juneau.*;
018import org.apache.juneau.json.annotation.*;
019
020/**
021 * Metadata on classes specific to the JSON serializers and parsers pulled from the {@link Json @Json} annotation on
022 * the class.
023 *
024 * <h5 class='section'>See Also:</h5><ul>
025 *    <li class='link'><a class="doclink" href="../../../../index.html#jm.JsonDetails">JSON Details</a>
026
027 * </ul>
028 */
029public class JsonClassMeta extends ExtendedClassMeta {
030
031   private final String wrapperAttr;
032
033   /**
034    * Constructor.
035    *
036    * @param cm The class that this annotation is defined on.
037    * @param mp JSON metadata provider (for finding information about other artifacts).
038    */
039   public JsonClassMeta(ClassMeta<?> cm, JsonMetaProvider mp) {
040      super(cm);
041
042      Value<String> wrapperAttr = Value.empty();
043      cm.forEachAnnotation(Json.class, x -> isNotEmpty(x.wrapperAttr()), x -> wrapperAttr.set(x.wrapperAttr()));
044      this.wrapperAttr = wrapperAttr.orElse(null);
045   }
046
047   /**
048    * Returns the {@link Json#wrapperAttr() @Json(wrapperAttr)} annotation defined on the class.
049    *
050    * @return The value of the annotation, or <jk>null</jk> if not specified.
051    */
052   protected String getWrapperAttr() {
053      return wrapperAttr;
054   }
055}