001package ball.upnp;
002/*-
003 * ##########################################################################
004 * UPnP/SSDP Implementation Classes
005 * %%
006 * Copyright (C) 2013 - 2022 Allen D. Ball
007 * %%
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *      http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 * ##########################################################################
020 */
021import ball.upnp.annotation.XmlNs;
022import org.springframework.core.annotation.AnnotationUtils;
023
024/**
025 * {@link Description} support for {@link XmlNs} annotation.
026 *
027 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
028 */
029public interface Description {
030
031    /**
032     * Method to get the {@link XmlNs}'s name.
033     *
034     * @return  The name.
035     */
036    default String getXmlns() {
037        XmlNs annotation = AnnotationUtils.findAnnotation(getClass(), XmlNs.class);
038
039        return (annotation != null) ? annotation.value() : null;
040    }
041}