qadevOOo/tests/java/ifc/inspection/_XObjectInspector.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: _XObjectInspector.java,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29  ************************************************************************/
  30
  31 package ifc.inspection;
  32
  33 import com.sun.star.inspection.XObjectInspector;
  34 import com.sun.star.inspection.XObjectInspectorModel;
  35 import com.sun.star.inspection.XObjectInspectorUI;
  36 import lib.MultiMethodTest;
  37 import lib.Status;
  38 import lib.StatusException;
  39
  40
  41 /**
  42  * Testing <code>com.sun.star.inspection.XObjectInspector</code>
  43  * interface methods :
  44  * <ul>
  45  *  <li><code> inspect()</code></li>
  46  *  <li><code> InspectorModel()</code></li>
  47  * </ul> <p>
  48  * Test is <b> NOT </b> multithread compilant. <p>
  49  *
  50  * This test needs the following object relations :
  51  * <ul>
  52  *  <li> <code>'XObjectInspector.toInspect'</code>
  53  *  (of type <code>Object []</code>):
  54  *   acceptable collection of one or more objects which can be inspected by <code>inspect()</code> </li>
  55  * <ul> <p>
  56  *
  57  */
  58
  59 public class _XObjectInspector extends MultiMethodTest {
  60
  61     /**
  62      * the test object
  63      */
  64     public XObjectInspector oObj = null;
  65     /**
  66      * This variable was filled with the object relation
  67      * <CODE>XObjectInspector.toInspect</CODE> and was used to
  68      * test the method <CODE>inspect()</CODE>
  69      */
  70     public Object[] oInspect = null;
  71     /**
  72      * This variable was filled with the object relation
  73      * <CODE>XObjectInspector.InspectorModelToSet</CODE> and was used to
  74      * test the method <CODE>setInspectorModel()</CODE>
  75      */
  76     public XObjectInspectorModel xSetModel = null;
  77
  78     /**
  79      * get object relations
  80      * <ul>
  81      *   <li>XObjectInspector.toInspect</li>
  82      * </ul>
  83      */
  84     public void before() {
  85
  86         oInspect = (Object[]) tEnv.getObjRelation("XObjectInspector.toInspect");
  87
  88         if (oInspect == null) throw new StatusException
  89                 (Status.failed("Relation 'XObjectInspector.toInspect' not found.")) ;
  90
  91         xSetModel = (XObjectInspectorModel) tEnv.getObjRelation("XObjectInspector.InspectorModelToSet");
  92
  93         if (xSetModel == null) throw new StatusException
  94                 (Status.failed("Relation 'XObjectInspector.InspectorModelToSet' not found.")) ;
  95     }
  96
  97     /**
  98      * Inspects a new collection of one or more objects given by object realtion
  99      * <CODE>XObjectInspector.toInspect</CODE><br>
 100      * Has <b>OK</b> status if no runtime exceptions occured.
 101      */
 102     public void _inspect() {
 103
 104         boolean result = true;
 105
 106         try {
 107             oObj.inspect(oInspect);
 108
 109         } catch (com.sun.star.util.VetoException e){
 110             log.println("ERROR:" + e.toString());
 111             result = false;
 112         }
 113
 114         tRes.tested("inspect()", result) ;
 115     }
 116
 117     /**
 118      * First call the method <CODE>getInspectorModel()</CODE> and save the value<br>
 119      * Second call the method <CODE>setInspectorModel()</CODE> with the module variable
 120      * <CODE>xSetModel</CODE> as parameter.<br> Then <CODE>getInspectorModel()</CODE>
 121      * was called and the returned valued was compared to the saved variable
 122      * <CODE>xSetModel</CODE><br>
 123      * Has <CODE>OK</CODE> status if the returned value is equal to
 124      * <CODE>xSetModel</CODE>.and the saved value is not null.
 125      */
 126     public void _InspectorModel() {
 127
 128         log.println("testing 'getInspectorModel()'...");
 129         XObjectInspectorModel xGetModel = oObj.getInspectorModel() ;
 130
 131         boolean result = xGetModel != null;
 132
 133         log.println(result? "got a not null object -> OK" : "got a NULL object -> FAILED");
 134
 135         log.println("testing 'setInspectorModel()'...");
 136         oObj.setInspectorModel(xSetModel);
 137
 138         XObjectInspectorModel xNewModel = oObj.getInspectorModel();
 139
 140         if (result) oObj.setInspectorModel(xGetModel);
 141
 142         result &= xSetModel.equals(xNewModel);
 143
 144         tRes.tested("InspectorModel()", result) ;
 145     }
 146
 147     /**
 148      * Calls the method <CODE>getInspectorUI()</CODE>
 149      * Has <b>OK</b> returned value is not null
 150      */
 151     public void _InspectorUI() {
 152
 153         XObjectInspectorUI oUI = oObj.getInspectorUI();
 154
 155         tRes.tested("InspectorUI()", oUI != null) ;
 156
 157     }
 158 }
 159
 160