1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: DescEntry.java,v $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
36 * Structure to describe the entries to be tested
39 public class DescEntry
{
42 * Contains the name used inside the framework
44 public String entryName
;
46 * Contains the name that may be used by state writers
48 public String longName
;
50 * Contains information if this entry is Optional
52 public boolean isOptional
;
54 * Contains information if this entry should be tested
56 public boolean isToTest
;
58 * Contains the information about the number of SubEntries
60 public int SubEntryCount
;
62 * Contains the SubEntries
64 public DescEntry
[] SubEntries
;
67 * Contains information about the Type of the entry<br>
68 * possible 'component', 'interface', 'service', 'method', 'property', 'unit'
70 public String EntryType
;
73 * Contains the ErrorMsg is something went wrong while gaining<br>
76 public String ErrorMsg
;
79 * Contains information if errors occured while gaining the Description
81 public boolean hasErrorMsg
;
84 * Contains the state for this entry
86 public String State
= "UNKNOWN";
89 * Contains the LogWriter to be used by the entry-test
92 public share
.LogWriter Logger
;
95 * Contains an arbitrary set of parameters
98 public java
.util
.Hashtable UserDefinedParams
= new java
.util
.Hashtable();