1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski 
25*b1cdbd2cSJim Jagielski package share;
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski /**
28*b1cdbd2cSJim Jagielski  *
29*b1cdbd2cSJim Jagielski  * Structure to describe the entries to be tested
30*b1cdbd2cSJim Jagielski  *
31*b1cdbd2cSJim Jagielski  */
32*b1cdbd2cSJim Jagielski public class DescEntry {
33*b1cdbd2cSJim Jagielski 
34*b1cdbd2cSJim Jagielski     /**
35*b1cdbd2cSJim Jagielski      * Contains the name used inside the framework
36*b1cdbd2cSJim Jagielski      */
37*b1cdbd2cSJim Jagielski     public String entryName;
38*b1cdbd2cSJim Jagielski     /**
39*b1cdbd2cSJim Jagielski      * Contains the name that may be used by state writers
40*b1cdbd2cSJim Jagielski      */
41*b1cdbd2cSJim Jagielski     public String longName;
42*b1cdbd2cSJim Jagielski     /**
43*b1cdbd2cSJim Jagielski      * Contains information if this entry is Optional
44*b1cdbd2cSJim Jagielski      */
45*b1cdbd2cSJim Jagielski     public boolean isOptional;
46*b1cdbd2cSJim Jagielski     /**
47*b1cdbd2cSJim Jagielski      * Contains information if this entry should be tested
48*b1cdbd2cSJim Jagielski      */
49*b1cdbd2cSJim Jagielski     public boolean isToTest;
50*b1cdbd2cSJim Jagielski     /**
51*b1cdbd2cSJim Jagielski      * Contains the information about the number of SubEntries
52*b1cdbd2cSJim Jagielski      */
53*b1cdbd2cSJim Jagielski     public int SubEntryCount;
54*b1cdbd2cSJim Jagielski     /**
55*b1cdbd2cSJim Jagielski      * Contains the SubEntries
56*b1cdbd2cSJim Jagielski      */
57*b1cdbd2cSJim Jagielski     public DescEntry[] SubEntries;
58*b1cdbd2cSJim Jagielski 
59*b1cdbd2cSJim Jagielski     /**
60*b1cdbd2cSJim Jagielski      * Contains information about the Type of the entry<br>
61*b1cdbd2cSJim Jagielski      * possible 'component', 'interface', 'service', 'method', 'property', 'unit'
62*b1cdbd2cSJim Jagielski      */
63*b1cdbd2cSJim Jagielski     public String EntryType;
64*b1cdbd2cSJim Jagielski 
65*b1cdbd2cSJim Jagielski     /**
66*b1cdbd2cSJim Jagielski      * Contains the ErrorMsg is something went wrong while gaining<br>
67*b1cdbd2cSJim Jagielski      * the description
68*b1cdbd2cSJim Jagielski      */
69*b1cdbd2cSJim Jagielski     public String ErrorMsg;
70*b1cdbd2cSJim Jagielski 
71*b1cdbd2cSJim Jagielski     /**
72*b1cdbd2cSJim Jagielski      * Contains information if errors occured while gaining the Description
73*b1cdbd2cSJim Jagielski      */
74*b1cdbd2cSJim Jagielski     public boolean hasErrorMsg;
75*b1cdbd2cSJim Jagielski 
76*b1cdbd2cSJim Jagielski     /**
77*b1cdbd2cSJim Jagielski      * Contains the state for this entry
78*b1cdbd2cSJim Jagielski      */
79*b1cdbd2cSJim Jagielski     public String State = "UNKNOWN";
80*b1cdbd2cSJim Jagielski 
81*b1cdbd2cSJim Jagielski     /**
82*b1cdbd2cSJim Jagielski      * Contains the LogWriter to be used by the entry-test
83*b1cdbd2cSJim Jagielski      */
84*b1cdbd2cSJim Jagielski 
85*b1cdbd2cSJim Jagielski     public share.LogWriter Logger;
86*b1cdbd2cSJim Jagielski 
87*b1cdbd2cSJim Jagielski     /**
88*b1cdbd2cSJim Jagielski      * Contains an arbitrary set of parameters
89*b1cdbd2cSJim Jagielski      */
90*b1cdbd2cSJim Jagielski 
91*b1cdbd2cSJim Jagielski     public java.util.Hashtable UserDefinedParams = new java.util.Hashtable();
92*b1cdbd2cSJim Jagielski 
93*b1cdbd2cSJim Jagielski }
94