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.urlencoding;
018
019import org.apache.juneau.commons.lang.*;
020import org.apache.juneau.marshall.*;
021
022/**
023 * Metadata on classes specific to the URL-Encoding serializers and parsers pulled from the {@link UrlEncoding @UrlEncoding} annotation on the class.
024 *
025 * <h5 class='section'>See Also:</h5><ul>
026 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/UrlEncodingSupport">URL-Encoding</a>
027 * </ul>
028 */
029public class UrlEncodingClassMeta extends ExtendedClassMeta {
030
031   private final boolean expandedParams;
032
033   /**
034    * Constructor.
035    *
036    * @param cm The class that this annotation is defined on.
037    *    <br>Must not be <jk>null</jk>.
038    * @param mp URL-encoding metadata provider (for finding information about other artifacts).
039    */
040   public UrlEncodingClassMeta(ClassMeta<?> cm, UrlEncodingMetaProvider mp) {
041      super(cm);
042
043      var expandedParams2 = Holder.<Boolean>empty();
044      cm.forEachAnnotation(UrlEncoding.class, UrlEncoding::expandedParams, x -> expandedParams2.set(true));
045      this.expandedParams = expandedParams2.orElse(false);
046   }
047
048   /**
049    * Returns the {@link UrlEncoding#expandedParams()} annotation defined on the class.
050    *
051    * @return The value of the {@link UrlEncoding#expandedParams()} annotation.
052    */
053   protected boolean isExpandedParams() { return expandedParams; }
054}