001package ball.upnp;
002/*-
003 * ##########################################################################
004 * UPnP/SSDP Implementation Classes
005 * $Id: AnnotatedDevice.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/AnnotatedDevice.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 ball.upnp.annotation.DeviceType;
024import java.net.URI;
025import org.springframework.core.annotation.AnnotationUtils;
026
027/**
028 * {@link Device} support for {@link DeviceType} and related annotations.
029 *
030 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
031 * @version $Revision: 5285 $
032 */
033public interface AnnotatedDevice {
034
035    /**
036     * Method to get the URN ({@link URI}) describing this
037     * {@link AnnotatedDevice}'s device type.
038     *
039     * @return  The service type.
040     */
041    default URI getDeviceType() {
042        DeviceType annotation =
043            AnnotationUtils.findAnnotation(getClass(), DeviceType.class);
044
045        return (annotation != null) ? URI.create(annotation.value()) : null;
046    }
047}