bundles/org.simantics.databoard/src/org/simantics/databoard/accessor/impl/AccessorParams.java

   1 /*******************************************************************************
   2  * Copyright (c) 2010- Association for Decentralized Information Management in
   3  * Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *    VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.databoard.accessor.impl;
  13
  14 import java.util.concurrent.locks.Lock;
  15
  16 import org.simantics.databoard.Bindings;
  17 import org.simantics.databoard.adapter.AdapterFactory;
  18 import org.simantics.databoard.binding.factory.BindingScheme;
  19 import org.simantics.databoard.serialization.SerializerScheme;
  20
  21 /**
  22  * This class carries implementation specific accessor parameters.
  23  * The object is typically propagated to sub-accessors.
  24  *
  25  * @author Toni Kalajainen <toni.kalajainen@vtt.fi>
  26  */
  27 public class AccessorParams {
  28
  29         public static final AccessorParams DEFAULT = new AccessorParams(null, null, Bindings.defaultBindingFactory, Bindings.adapterFactory, Bindings.serializationFactory);
  30
  31         /*
  32          * With locks there are three use scenarios:
  33          *
  34          *  a) No locks
  35          *  b) One lock, mutual exclusion
  36          *  c) Read and write lock, See ReentrantReadWriteLock
  37          *
  38          */
  39
  40         /** Read Lock, optional */
  41         public Lock readLock;
  42         /** Write Lock, optional */
  43         public Lock writeLock;
  44
  45         /** Binding Scheme */
  46         public BindingScheme bindingScheme;
  47
  48         /** Adapter Scheme */
  49         public AdapterFactory adapterScheme;
  50
  51         /** Serializer Scheme */
  52         public SerializerScheme serializerScheme;
  53
  54         public AccessorParams(Lock readLock, Lock writeLock, BindingScheme bindingScheme, AdapterFactory adapterScheme, SerializerScheme serializerScheme) {
  55                 this.readLock = readLock;
  56                 this.writeLock = writeLock;
  57                 this.bindingScheme = bindingScheme;
  58                 this.adapterScheme = adapterScheme;
  59                 this.serializerScheme = serializerScheme;
  60         }
  61
  62 }
  63