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.urlencoding;
018
019import org.apache.juneau.*;
020import org.apache.juneau.commons.lang.*;
021import org.apache.juneau.urlencoding.annotation.*;
022
023/**
024 * Metadata on classes specific to the URL-Encoding serializers and parsers pulled from the {@link UrlEncoding @UrlEncoding} annotation on the class.
025 *
026 * <h5 class='section'>See Also:</h5><ul>
027 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/UrlEncodingBasics">URL-Encoding Basics</a>
028 * </ul>
029 */
030public class UrlEncodingClassMeta extends ExtendedClassMeta {
031
032   private final boolean expandedParams;
033
034   /**
035    * Constructor.
036    *
037    * @param cm The class that this annotation is defined on.
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 expandedParams = Value.<Boolean>empty();
044      cm.forEachAnnotation(UrlEncoding.class, UrlEncoding::expandedParams, x -> expandedParams.set(true));
045      this.expandedParams = expandedParams.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}