1 /*
2 * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.properties.tutorial.property.key;
17
18 import de.smartics.properties.api.core.annotations.PropertySet;
19 import de.smartics.properties.api.core.domain.PropertyDescriptor;
20 import de.smartics.properties.api.core.domain.PropertyKey;
21
22 /**
23 * A sample property set for the {@link PropertyKeyAccessTutorial}.
24 */
25 @PropertySet(value = "tutorial.property.key")
26 public interface DescriptorAndKeyProperties
27 {
28 /**
29 * Returns the name of the host. This name is used to construct URLs by adding
30 * a protocol, an optional port and request path. It is allowed to set an IP
31 * address as specified in <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC
32 * 2396</a>.
33 *
34 * @return the name of the host.
35 */
36 String host();
37
38 /**
39 * Returns the property descriptor for the {@link host #host()} property.
40 *
41 * @return the property descriptor for the {@link host #host()} property.
42 */
43 PropertyDescriptor hostPropertyDescriptor();
44
45 /**
46 * Returns the property key for the {@link host #host()} property.
47 *
48 * @return the property key for the {@link host #host()} property.
49 */
50 PropertyKey hostPropertyKey();
51 }