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.propertyset;
17
18 import de.smartics.projectdoc.annotations.DocCategory;
19 import de.smartics.projectdoc.annotations.Document;
20 import de.smartics.projectdoc.annotations.topic.DocChapter;
21 import de.smartics.projectdoc.annotations.topic.DocPrerequisites;
22 import de.smartics.properties.tutorial.onestringproperty.OneStringPropertyTutorial;
23
24 /**
25 * This tutorial explains the
26 * {@link de.smartics.properties.api.core.annotations.PropertySet} annotation.
27 * <p>
28 * We have seen in the
29 * {@link de.smartics.properties.tutorial.onestringproperty.OneStringPropertyTutorial}
30 * how property sets are declared. Here we provide detailed information about
31 * the declaration of property sets.
32 * </p>
33 */
34 @Document(title = "PropertySet Tutorial", sortKey = "basics0020")
35 @DocCategory({ "basics" })
36 @DocPrerequisites({ OneStringPropertyTutorial.class })
37 public class PropertySetTutorial
38 {
39 /**
40 * {@insertDoc type="de.smartics.properties.api.core.annotations.PropertySet"}
41 */
42 @DocChapter
43 void declaration()
44 {
45 }
46
47 /**
48 * {@insertCode source="PropertySetWithName"}
49 */
50 @DocChapter
51 void propertySetWithName()
52 {
53 }
54
55 /**
56 * {@insertCode source="PropertySetWithDefaultName"}
57 */
58 @DocChapter
59 void propertySetWithDefaultName()
60 {
61 }
62
63 /**
64 * {@insertCode source="PropertySetWithoutName"}
65 */
66 @DocChapter
67 void propertySetWithoutName()
68 {
69 }
70
71 /**
72 * {@insertCode source="ForeignPropertySet"}
73 */
74 @DocChapter
75 void foreignPropertySet()
76 {
77 }
78
79 /**
80 * {@insertCode source="VirtualPropertySet"}
81 */
82 @DocChapter
83 void virtualPropertySet()
84 {
85 }
86 }