001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.marshall.json;
018
019import static org.apache.juneau.commons.utils.Shorts.*;
020
021import org.apache.juneau.commons.lang.*;
022import org.apache.juneau.marshall.*;
023
024/**
025 * Metadata on classes specific to the JSON serializers and parsers pulled from the {@link Json @Json} annotation on
026 * the class.
027 *
028 * <h5 class='section'>See Also:</h5><ul>
029 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JsonSupport">JSON</a>
030
031 * </ul>
032 */
033public class JsonClassMeta extends ExtendedClassMeta {
034
035   private final String wrapperAttr;
036
037   /**
038    * Constructor.
039    *
040    * @param cm The class that this annotation is defined on.
041    *    <br>Must not be <jk>null</jk>.
042    * @param mp JSON metadata provider (for finding information about other artifacts).
043    */
044   public JsonClassMeta(ClassMeta<?> cm, JsonMetaProvider mp) {
045      super(cm);
046
047      var wrapperAttr2 = Holder.<String>empty();
048      cm.forEachAnnotation(Json.class, x -> ine(x.wrapperAttr()), x -> wrapperAttr2.set(x.wrapperAttr()));
049      this.wrapperAttr = wrapperAttr2.orElse(null);
050   }
051
052   /**
053    * Returns the {@link Json#wrapperAttr() @Json(wrapperAttr)} annotation defined on the class.
054    *
055    * @return The value of the annotation, or <jk>null</jk> if not specified.
056    */
057   protected String getWrapperAttr() { return wrapperAttr; }
058}