qadevOOo/tests/java/ifc/beans/_XPropertyState.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 package ifc.beans;
  20
  21 import lib.MultiMethodTest;
  22 import lib.Status;
  23 import lib.StatusException;
  24
  25 import com.sun.star.beans.Property;
  26 import com.sun.star.beans.PropertyAttribute;
  27 import com.sun.star.beans.PropertyState;
  28 import com.sun.star.beans.XPropertySet;
  29 import com.sun.star.beans.XPropertySetInfo;
  30 import com.sun.star.beans.XPropertyState;
  31 import com.sun.star.uno.Any;
  32 import com.sun.star.uno.UnoRuntime;
  33
  34
  35 /**
  36 * Testing <code>com.sun.star.beans.XPropertyState</code>
  37 * interface methods :
  38 * <ul>
  39 *  <li><code> getPropertyState()</code></li>
  40 *  <li><code> getPropertyStates()</code></li>
  41 *  <li><code> setPropertyToDefault()</code></li>
  42 *  <li><code> getPropertyDefault()</code></li>
  43 * </ul>
  44 * Test is <b> NOT </b> multithread compilant. <p>
  45 * After test completion object environment has to be recreated. <p>
  46 * <b>Note:</b> object tested must also implement
  47 * <code>com.sun.star.beans.XPropertySet</code> interface.
  48 * @see com.sun.star.beans.XPropertyState
  49 */
  50 public class _XPropertyState extends MultiMethodTest {
  51
  52         public XPropertyState oObj = null;
  53
  54         private XPropertySet oPS = null ;
  55         private XPropertySetInfo propertySetInfo = null;
  56         private Property[] properties = null ;
  57         private String pName = null ;
  58         private Object propDef = null ;
  59
  60         /**
  61         * Queries object for <code>XPropertySet</code> interface and
  62         * initializes some fields used by all methods. <p>
  63         *
  64         * Searches property which is not READONLY and MAYBEDEFAULT, if
  65         * such property is not found, then uses property with only
  66         * READONLY attribute. This property name is stored and is used
  67         * by all tests.
  68         *
  69         * @throws StatusException If <code>XPropertySet</code> is not
  70         * implemented by object.
  71         */
  72         public void before() throws StatusException {
  73             oPS = UnoRuntime.queryInterface( XPropertySet.class, oObj );
  74             if (oPS == null)
  75                 throw new StatusException
  76                     ("XPropertySet interface isn't implemented.",
  77                         new NullPointerException
  78                             ("XPropertySet interface isn't implemented.")) ;
  79
  80             propertySetInfo = oPS.getPropertySetInfo();
  81             properties = propertySetInfo.getProperties();
  82             Property prop = null;
  83             for (int i=0;i<properties.length;i++) {
  84                 try {
  85                     prop = propertySetInfo.getPropertyByName
  86                         (properties[i].Name);
  87                 } catch (com.sun.star.beans.UnknownPropertyException e) {
  88                     log.println("Unknown Property "+prop.Name);
  89                 }
  90                 boolean readOnly = (prop.Attributes &
  91                     PropertyAttribute.READONLY) != 0;
  92                 boolean maybeDefault = (prop.Attributes &
  93                     PropertyAttribute.MAYBEDEFAULT) != 0;
  94                 if (!readOnly && maybeDefault) {
  95                     pName = properties[i].Name;
  96                     log.println("Property '" + pName + "' has attributes "+
  97                          prop.Attributes);
  98                     break ;
  99                 } else
 100                 if (!readOnly) {
 101                     pName = properties[i].Name;
 102                     log.println("Property '" + pName +
 103                          "' is not readonly, may be used ...");
 104                 } else {
 105                     log.println("Skipping property '" + properties[i].Name +
 106                         "' Readonly: " + readOnly + ", MaybeDefault: " +
 107                              maybeDefault);
 108                 }
 109             }
 110
 111         }
 112
 113         /**
 114         * Test calls the method and checks that no exceptions were thrown. <p>
 115         * Has <b> OK </b> status if no exceptions were thrown. <p>
 116         */
 117         public void _getPropertyDefault(){
 118             boolean result = true ;
 119             String localName = pName;
 120             if (localName == null) {
 121                 localName = (propertySetInfo.getProperties()[0]).Name;
 122             }
 123             try {
 124                 propDef = oObj.getPropertyDefault(localName);
 125                 log.println("Default property value is : '" + propDef + "'");
 126             } catch (com.sun.star.beans.UnknownPropertyException e) {
 127                 log.println("Exception " + e +
 128                     "occurred while getting Property default");
 129                 result=false;
 130             } catch (com.sun.star.lang.WrappedTargetException e) {
 131                 log.println("Exception " + e +
 132                     "occurred while getting Property default");
 133                 result=false;
 134             }
 135             tRes.tested("getPropertyDefault()", result);
 136         }
 137
 138         /**
 139         * Test calls the method and checks return value and that
 140         * no exceptions were thrown. <p>
 141         * Has <b> OK </b> status if the method returns not null value
 142         * and no exceptions were thrown. <p>
 143         */
 144         public void _getPropertyState(){
 145             boolean result = true ;
 146
 147             String localName = pName;
 148             if (localName == null) {
 149                 localName = (propertySetInfo.getProperties()[0]).Name;
 150             }
 151
 152             try {
 153                 PropertyState ps = oObj.getPropertyState(localName);
 154                 if (ps == null) {
 155                     log.println("!!! Returned value == null") ;
 156                     result = false ;
 157                 }
 158             } catch (com.sun.star.beans.UnknownPropertyException e) {
 159                 log.println("Exception " + e +
 160                     "occurred while getting Property state");
 161                 result = false;
 162             }
 163             tRes.tested("getPropertyState()", result);
 164         }
 165
 166         /**
 167         * Test calls the method with array of one property name
 168         * and checks return value and that no exceptions were thrown. <p>
 169         * Has <b> OK </b> status if the method returns array with one
 170         * PropertyState and no exceptions were thrown. <p>
 171         */
 172         public void _getPropertyStates(){
 173             boolean result = true ;
 174
 175             String localName = pName;
 176             if (localName == null) {
 177                 localName = (propertySetInfo.getProperties()[0]).Name;
 178             }
 179
 180             try {
 181                 PropertyState[] ps = oObj.getPropertyStates
 182                     (new String[] {localName});
 183                 if (ps == null) {
 184                     log.println("!!! Returned value == null") ;
 185                     result = false ;
 186                 } else {
 187                     if (ps.length != 1) {
 188                         log.println("!!! Array lebgth returned is invalid - " +
 189                              ps.length) ;
 190                         result = false ;
 191                     }
 192                 }
 193             } catch (com.sun.star.beans.UnknownPropertyException e) {
 194                 log.println("Exception " + e +
 195                     "occurred while getting Property state");
 196                 result = false;
 197             }
 198
 199             tRes.tested("getPropertyStates()", result);
 200         }
 201
 202
 203         /**
 204         * Sets the property to default, then compares the current property
 205         * value to value received by method <code>getPropertyDefault</code>.
 206         * Has <b> OK </b> status if the current proeprty value equals to
 207         * default property. <p>
 208         * The following method tests are to be completed successfully before :
 209         * <ul>
 210         *  <li> <code>getPropertyDefault</code>: we have to know what is
 211         * default value</li></ul>
 212         */
 213         public void _setPropertyToDefault(){
 214             requiredMethod("getPropertyDefault()") ;
 215
 216             if (pName == null) {
 217                 log.println("all found properties are read only");
 218                 tRes.tested("setPropertyToDefault()",Status.skipped(true));
 219                 return;
 220             }
 221
 222             boolean result = true ;
 223             try {
 224                 try {
 225                     oObj.setPropertyToDefault(pName);
 226                 }
 227                 catch(RuntimeException e) {
 228                     System.out.println("Ignoring RuntimeException: " + e.getMessage());
 229                 }
 230                 if ((properties[0].Attributes &
 231                         PropertyAttribute.MAYBEDEFAULT) != 0) {
 232                     Object actualDef = propDef ;
 233                     if (propDef instanceof Any) {
 234                         actualDef = ((Any)propDef).getObject() ;
 235                     }
 236                     Object actualVal = oPS.getPropertyValue(pName) ;
 237                     if (actualVal instanceof Any) {
 238                         actualVal = ((Any)actualVal).getObject() ;
 239                     }
 240                     result = util.ValueComparer.equalValue
 241                         (actualDef,actualVal) ;
 242                     log.println("Default value = '" + actualDef +
 243                          "', returned value = '"
 244                         + actualVal + "' for property " + pName) ;
 245                 }
 246             } catch (com.sun.star.beans.UnknownPropertyException e) {
 247                 log.println("Exception " + e +
 248                     "occurred while setting Property to default");
 249                 result=false;
 250             } catch (com.sun.star.lang.WrappedTargetException e) {
 251                 log.println("Exception " + e +
 252                     "occurred while testing property value");
 253                 result=false;
 254             }
 255
 256             tRes.tested("setPropertyToDefault()", result);
 257         }
 258
 259         public void after() {
 260             disposeEnvironment() ;
 261         }
 262
 263  }// EOF _XPropertyState
 264