KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > osgi > service > device > Constants


1 /*
2  * $Header: /cvshome/build/org.osgi.service.device/src/org/osgi/service/device/Constants.java,v 1.9 2006/07/11 00:54:08 hargrave Exp $
3  *
4  * Copyright (c) OSGi Alliance (2000, 2006). All Rights Reserved.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 package org.osgi.service.device;
19
20 /**
21  * This interface defines standard names for property keys associated with
22  * {@link Device} and {@link Driver} services.
23  *
24  * <p>
25  * The values associated with these keys are of type <code>java.lang.String</code>,
26  * unless otherwise stated.
27  *
28  * @version $Revision: 1.9 $
29  * @since 1.1
30  * @see Device
31  * @see Driver
32  */
33 public interface Constants {
34     /**
35      * Property (named &quot;DRIVER_ID&quot;) identifying a driver.
36      *
37      * <p>
38      * A <code>DRIVER_ID</code> should start with the reversed domain name of the
39      * company that implemented the driver (e.g., <code>com.acme</code>), and
40      * must meet the following requirements:
41      *
42      * <ul>
43      * <li>It must be independent of the location from where it is obtained.
44      * <li>It must be independent of the {@link DriverLocator} service that
45      * downloaded it.
46      * <li>It must be unique.
47      * <li>It must be different for different revisions of the same driver.
48      * </ul>
49      *
50      * <p>
51      * This property is mandatory, i.e., every <code>Driver</code> service must be
52      * registered with it.
53      */
54     public static final String JavaDoc DRIVER_ID = "DRIVER_ID";
55     /**
56      * Property (named &quot;DEVICE_CATEGORY&quot;) containing a human readable
57      * description of the device categories implemented by a device. This
58      * property is of type <code>String[]</code>
59      *
60      * <p>
61      * Services registered with this property will be treated as devices and
62      * discovered by the device manager
63      */
64     public static final String JavaDoc DEVICE_CATEGORY = "DEVICE_CATEGORY";
65     /**
66      * Property (named &quot;DEVICE_SERIAL&quot;) specifying a device's serial
67      * number.
68      */
69     public static final String JavaDoc DEVICE_SERIAL = "DEVICE_SERIAL";
70     /**
71      * Property (named &quot;DEVICE_DESCRIPTION&quot;) containing a human
72      * readable string describing the actual hardware device.
73      */
74     public static final String JavaDoc DEVICE_DESCRIPTION = "DEVICE_DESCRIPTION";
75 }
76
Popular Tags