File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\model\ViewPropertyDescriptor.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2011, CloudBees, Inc., Stephen Connolly
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.model;
25
26 /**
27 * {@link Descriptor} for {@link ViewProperty}
28 *
29 * @author Stephen Connolly
30 * @since 1.406
31 */
32 public abstract class ViewPropertyDescriptor extends Descriptor<ViewProperty> {
33 protected ViewPropertyDescriptor(Class<? extends ViewProperty> clazz) {
34 super(clazz);
35 }
36
37 /**
38 * Infers the type of the corresponding {@link Describable} from the outer class.
39 * This version works when you follow the common convention, where a descriptor
40 * is written as the static nested class of the describable class.
41 */
42 protected ViewPropertyDescriptor() {
43 }
44
45 /**
46 * Creates a default instance of {@link ViewProperty} to be associated
47 * with {@link View} object that wasn't created from a persisted XML data.
48 *
49 * <p>
50 * See {@link View} class javadoc for more details about the life cycle
51 * of {@link View} and when this method is invoked.
52 *
53 * @return null
54 * if the implementation choose not to add any property object for such view.
55 */
56 public ViewProperty newInstance(View view) {
57 return null;
58 }
59
60 /**
61 * Whether or not the described property is enabled in the current context.
62 * Defaults to true. Over-ride in sub-classes as required.
63 *
64 * <p>
65 * Returning false from this method essentially has the same effect of
66 * making core behaves as if this {@link ViewPropertyDescriptor} is
67 * not a part of {@link ViewProperty#all()}.
68 *
69 * <p>
70 * This mechanism is useful if the availability of the property is
71 * contingent of some other settings.
72 *
73 * @param view
74 * View for which this property is considered. Never null.
75 */
76 public boolean isEnabledFor(View view) {
77 return true;
78 }
79 }
80