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.xml;
018
019import org.apache.juneau.commons.bean.*;
020import org.apache.juneau.marshall.*;
021
022/**
023 * Interface for providing access to {@link XmlClassMeta}, {@link XmlBeanMeta}, and {@link XmlBeanPropertyMeta} objects.
024 *
025 * <h5 class='section'>See Also:</h5><ul>
026 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/XmlSupport">XML</a>
027 * </ul>
028 */
029public interface XmlMetaProvider {
030
031   /**
032    * Returns the language-specific metadata on the specified bean.
033    *
034    * @param bm The bean to return the metadata on.
035    * @return The metadata.
036    */
037   XmlBeanMeta getXmlBeanMeta(BeanMeta<?> bm);
038
039   /**
040    * Returns the language-specific metadata on the specified bean property.
041    *
042    * @param bpm The bean property to return the metadata on.
043    * @return The metadata.
044    */
045   XmlBeanPropertyMeta getXmlBeanPropertyMeta(BeanPropertyMeta bpm);
046
047   /**
048    * Returns the language-specific metadata on the specified class.
049    *
050    * @param cm The class to return the metadata on.
051    * @return The metadata.
052    */
053   XmlClassMeta getXmlClassMeta(ClassMeta<?> cm);
054}