001package ball.upnp;
002/*-
003 * ##########################################################################
004 * UPnP/SSDP Implementation Classes
005 * $Id: XmlDocument.java 5285 2020-02-05 04:23:21Z ball $
006 * $HeadURL: svn+ssh://svn.hcf.dev/var/spool/scm/repository.svn/ball-upnp/trunk/src/main/java/ball/upnp/XmlDocument.java $
007 * %%
008 * Copyright (C) 2013 - 2020 Allen D. Ball
009 * %%
010 * Licensed under the Apache License, Version 2.0 (the "License");
011 * you may not use this file except in compliance with the License.
012 * You may obtain a copy of the License at
013 *
014 *      http://www.apache.org/licenses/LICENSE-2.0
015 *
016 * Unless required by applicable law or agreed to in writing, software
017 * distributed under the License is distributed on an "AS IS" BASIS,
018 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
019 * See the License for the specific language governing permissions and
020 * limitations under the License.
021 * ##########################################################################
022 */
023import javax.xml.bind.annotation.XmlRootElement;
024import org.springframework.core.annotation.AnnotationUtils;
025
026/**
027 * Support for {@link XmlRootElement} and related annotations.
028 *
029 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
030 * @version $Revision: 5285 $
031 */
032public interface XmlDocument {
033
034    /**
035     * Method to get the {@link XmlRootElement} annotation.
036     *
037     * @return  The {@link XmlRootElement} annotation.
038     */
039    default XmlRootElement getXmlRootElement() {
040        return AnnotationUtils.findAnnotation(getClass(),
041                                              XmlRootElement.class);
042    }
043}