ridljar/com/sun/star/comp/helper/ComponentContextEntry.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 package com.sun.star.comp.helper;
  19
  20 /** Component context entry for constructing ComponentContext objects.
  21     <p>
  22     A ComponentContextEntry is separated into a late-init and direct-value
  23     purpose.
  24     The first one is commonly used for singleton objects of the component
  25     context, that are raised on first-time retrieval of the key.
  26     You have to pass a com.sun.star.lang.XSingleComponentFactory
  27     or string (=&gt; service name) object for this.
  28     </p>
  29 */
  30 public class ComponentContextEntry
  31 {
  32     /** if late init of service instance, set service name (String) or
  33         component factory (XSingleComponentFactory), null otherwise
  34     */
  35     public Object m_lateInit;
  36     /** set entry value
  37     */
  38     public Object m_value;
  39
  40     /** Creating a late-init singleton entry component context entry.
  41         The second parameter will be ignored and overwritten during
  42         instantiation of the singleton instance.
  43
  44         @param lateInit
  45                object factory or service string
  46         @param value
  47                pass null (dummy separating from second constructor signature)
  48     */
  49     public ComponentContextEntry( Object lateInit, Object value )
  50     {
  51         this.m_lateInit = lateInit;
  52         this.m_value = value;
  53     }
  54     /** Creating a direct value component context entry.
  55
  56         @param value
  57                pass null
  58     */
  59     public ComponentContextEntry( Object value )
  60     {
  61         this.m_lateInit = null;
  62         this.m_value = value;
  63     }
  64 }