ridljar/com/sun/star/uno/Any.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
  20 package com.sun.star.uno;
  21
  22
  23 /**
  24  * The UNO IDL type any is mapped to java type <code>java.lang.Object</code>.
  25  * <p>
  26  * In special cases it is necessary to have an explicit any to additionally transport
  27  * an exact type. For instance if you want to pass an object reference via
  28  * an interprocess connection using an any, you should use this class to add
  29  * an explicit interface type, so the remote counterpart doesn't need to invoke
  30  * a queryInterface).
  31  * </p>
  32  */
  33 public class Any {
  34     /**
  35      * The type of the any.
  36      *
  37      * @see #getType
  38      */
  39     protected Type  _type;
  40
  41     /**
  42      * The data of the any.
  43      *
  44      * @see #getObject
  45      */
  46     protected Object _object;
  47
  48     public static final Any VOID = new Any(new Type("void", TypeClass.VOID),
  49                                            null);
  50         // do not use Type.VOID here to avoid circular dependencies between
  51         // static members of Any and Type
  52
  53     /**
  54      * Constructs a new any.
  55      *
  56      * @param   zInterface  the type of the any.
  57      * @param   object      the data of the any.
  58      * @deprecated as of UDK 2.0
  59      */
  60     @Deprecated
  61     public Any(Class<?> zInterface, Object object) {
  62         this(new Type(zInterface), object);
  63     }
  64
  65     /**
  66      * Constructs a new any with a given type and value
  67      *
  68      * @param type the UNO type of the any.
  69      * @param object the value of the any.
  70      */
  71     public Any(Type type, Object object) {
  72         if (type.equals(Type.ANY)) {
  73             throw new IllegalArgumentException("Any cannot contain Any");
  74         }
  75         _type   = type;
  76         _object = object;
  77     }
  78
  79     /**
  80      * Complete a UNO <code>ANY</code> (make sure it is wrapped up as an
  81      * <code>Any</code> instance).
  82      *
  83      * @param any a Java value representing a UNO <code>ANY</code> value.
  84      * @return a complete Java value (that is, an <code>Any</code> instance)
  85      * representing the same UNO <code>ANY</code> value as the given argument.
  86      * @since UDK 3.2.3
  87     */
  88     public static final Any complete(Object any) {
  89         return any instanceof Any
  90             ? (Any) any
  91             : new Any(
  92                 new Type(any == null ? XInterface.class : any.getClass()), any);
  93     }
  94
  95     /**
  96      * Gets the type of the value within the any.
  97      *
  98      * @return the type of the value within the any.
  99      */
 100     public Type getType() {
 101         return _type;
 102     }
 103
 104     /**
 105      * Gets the value within the any.
 106      *
 107      * @return gets the value within the any.
 108      */
 109     public Object getObject() {
 110         return _object;
 111     }
 112
 113     /**
 114      * Indicates whether some other object is equal to this one.
 115      *
 116      * @param obj the reference object with which to compare.
 117      * @return <code>true</code> if this object is the same as the obj argument;
 118      * <code>false</code> otherwise.
 119      * @see java.lang.Object#equals
 120      */
 121     @Override
 122     public boolean equals(Object obj) {
 123         return obj instanceof Any && _type.equals(((Any) obj)._type)
 124             && (_object == null
 125                 ? ((Any) obj)._object == null
 126                 : _object.equals(((Any) obj)._object));
 127     }
 128
 129     /**
 130      * Returns a hash code value for the object.
 131      *
 132      * @return a hash code value for this object.
 133      * @see java.lang.Object#hashCode
 134      */
 135     @Override
 136     public int hashCode() {
 137         return _type.hashCode() * 13
 138             + (_object == null ? 0 : _object.hashCode());
 139     }
 140
 141     /**
 142      * Returns a string representation of the object.
 143      *
 144      * @return a string representation of the object.
 145      * @see java.lang.Object#toString
 146      */
 147     @Override
 148     public String toString() {
 149         return "Any[" + _type + ", " + _object + "]";
 150     }
 151 }