001package ball.upnp;
002/*-
003 * ##########################################################################
004 * UPnP/SSDP Implementation Classes
005 * $Id: Description.java 7215 2021-01-03 18:39:51Z ball $
006 * $HeadURL: svn+ssh://svn.hcf.dev/var/spool/scm/repository.svn/ball-upnp/trunk/src/main/java/ball/upnp/Description.java $
007 * %%
008 * Copyright (C) 2013 - 2021 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 ball.upnp.annotation.XmlNs;
024import org.springframework.core.annotation.AnnotationUtils;
025
026/**
027 * {@link Description} support for {@link XmlNs} annotation.
028 *
029 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
030 * @version $Revision: 7215 $
031 */
032public interface Description {
033
034    /**
035     * Method to get the {@link XmlNs}'s name.
036     *
037     * @return  The name.
038     */
039    default String getXmlns() {
040        XmlNs annotation =
041            AnnotationUtils.findAnnotation(getClass(), XmlNs.class);
042
043        return (annotation != null) ? annotation.value() : null;
044    }
045}