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.urlencoding;
014
015import java.util.*;
016
017import org.apache.juneau.*;
018import org.apache.juneau.urlencoding.annotation.*;
019
020/**
021 * Metadata on classes specific to the URL-Encoding serializers and parsers pulled from the {@link UrlEncoding @UrlEncoding} annotation on the class.
022 */
023public class UrlEncodingClassMeta extends ExtendedClassMeta {
024
025   private final List<UrlEncoding> urlEncodings;
026   private final boolean expandedParams;
027
028   /**
029    * Constructor.
030    *
031    * @param cm The class that this annotation is defined on.
032    * @param mp URL-encoding metadata provider (for finding information about other artifacts).
033    */
034   public UrlEncodingClassMeta(ClassMeta<?> cm, UrlEncodingMetaProvider mp) {
035      super(cm);
036      this.urlEncodings = cm.getAnnotations(UrlEncoding.class);
037
038      boolean _expandedParams = false;
039      for (UrlEncoding a : urlEncodings)
040         if (a.expandedParams())
041            _expandedParams = true;
042
043      this.expandedParams = _expandedParams;
044   }
045
046   /**
047    * Returns the {@link UrlEncoding} annotations defined on the class.
048    *
049    * @return An unmodifiable list of annotations ordered parent-to-child, or an empty list if not found.
050    */
051   protected List<UrlEncoding> getAnnotations() {
052      return urlEncodings;
053   }
054
055   /**
056    * Returns the {@link UrlEncoding#expandedParams()} annotation defined on the class.
057    *
058    * @return The value of the {@link UrlEncoding#expandedParams()} annotation.
059    */
060   protected boolean isExpandedParams() {
061      return expandedParams;
062   }
063}