-/*******************************************************************************\r
- * Copyright (c) 2010 Association for Decentralized Information Management in\r
- * Industry THTH ry.\r
- * All rights reserved. This program and the accompanying materials\r
- * are made available under the terms of the Eclipse Public License v1.0\r
- * which accompanies this distribution, and is available at\r
- * http://www.eclipse.org/legal/epl-v10.html\r
- *\r
- * Contributors:\r
- * VTT Technical Research Centre of Finland - initial API and implementation\r
- *******************************************************************************/\r
+/*******************************************************************************
+ * Copyright (c) 2010 Association for Decentralized Information Management in
+ * Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
package org.simantics.databoard.accessor;
-import java.util.Map;\r
-\r
-import org.simantics.databoard.accessor.error.AccessorConstructionException;\r
-import org.simantics.databoard.accessor.error.AccessorException;\r
-import org.simantics.databoard.accessor.impl.MapAccessorIterator;\r
-import org.simantics.databoard.binding.ArrayBinding;\r
-import org.simantics.databoard.binding.Binding;\r
-import org.simantics.databoard.binding.error.BindingException;\r
-import org.simantics.databoard.type.MapType;\r
-\r
-/**\r
- * Map accessor is an interface to value container of map type\r
- *\r
- * @see MapAccessorIterator iterator helper class\r
- * @author Toni Kalajainen <toni.kalajainen@vtt.fi>\r
+import java.util.Map;
+
+import org.simantics.databoard.accessor.error.AccessorConstructionException;
+import org.simantics.databoard.accessor.error.AccessorException;
+import org.simantics.databoard.accessor.impl.MapAccessorIterator;
+import org.simantics.databoard.binding.ArrayBinding;
+import org.simantics.databoard.binding.Binding;
+import org.simantics.databoard.binding.error.BindingException;
+import org.simantics.databoard.type.MapType;
+
+/**
+ * Map accessor is an interface to value container of map type
+ *
+ * @see MapAccessorIterator iterator helper class
+ * @author Toni Kalajainen <toni.kalajainen@vtt.fi>
*/
public interface MapAccessor extends Accessor {
* @throws AccessorException
*/
void remove(Binding keyBinding, Object key) throws AccessorException;
- \r
- /**\r
- * Remove all values between an two keys. \r
- * \r
- * If there is an existing accessor, it becomes invalid.\r
- * \r
- * @param keyBinding\r
- * @param startKey start key, inclusive\r
- * @param endKey end key, exclusive\r
- * @throws AccessorException\r
- */\r
-// void removeRange(Binding keyBinding, Object startKey, Object endKey) throws AccessorException;\r
- \r
- /**\r
- * Clear all entries.\r
- * \r
- * If there is an accessor to a removed container, it becomes invalid.\r
- * \r
- * @throws AccessorException\r
- */\r
- void clear() throws AccessorException;\r
+
+ /**
+ * Remove all values between an two keys.
+ *
+ * If there is an existing accessor, it becomes invalid.
+ *
+ * @param keyBinding
+ * @param startKey start key, inclusive
+ * @param endKey end key, exclusive
+ * @throws AccessorException
+ */
+// void removeRange(Binding keyBinding, Object startKey, Object endKey) throws AccessorException;
+
+ /**
+ * Clear all entries.
+ *
+ * If there is an accessor to a removed container, it becomes invalid.
+ *
+ * @throws AccessorException
+ */
+ void clear() throws AccessorException;
/**
* Put entries from a map. Replaces any possible existing entry.
* @throws AccessorException
*/
void getAll(Binding keyBinding, Binding valueBinding, Object[] keys, Object[] values) throws AccessorException;
- \r
- /**\r
- * Count the number of entries between two keyes\r
- * @param keyBinding\r
- * @param from\r
- * @param fromInclusive\r
- * @param end \r
- * @param endInclusive\r
- * @return number of entries in range \r
- * @throws AccessorException\r
- */\r
- int count(Binding keyBinding, Object from, boolean fromInclusive, Object end, boolean endInclusive) throws AccessorException;\r
-\r
- /**\r
- * Read a range of entries\r
- * \r
- * @param keyBinding\r
- * @param from\r
- * @param fromInclusive\r
- * @param end\r
- * @param endInclusive\r
- * @param keyArrayBinding\r
- * @param keysArray\r
- * @param valueArrayBinding\r
- * @param valueArray\r
- * @param resultLimit maximum number of entries to read, -1 for no limit\r
- * @return the number of entries read \r
- * @throws AccessorException\r
- */\r
- int getEntries(Binding keyBinding, Object from, boolean fromInclusive, Object end, boolean endInclusive, \r
- ArrayBinding keyArrayBinding, Object keysArray, \r
- ArrayBinding valueArrayBinding, Object valueArray, \r
- int resultLimit) throws AccessorException; \r
+
+ /**
+ * Count the number of entries between two keyes
+ * @param keyBinding
+ * @param from
+ * @param fromInclusive
+ * @param end
+ * @param endInclusive
+ * @return number of entries in range
+ * @throws AccessorException
+ */
+ int count(Binding keyBinding, Object from, boolean fromInclusive, Object end, boolean endInclusive) throws AccessorException;
+
+ /**
+ * Read a range of entries
+ *
+ * @param keyBinding
+ * @param from
+ * @param fromInclusive
+ * @param end
+ * @param endInclusive
+ * @param keyArrayBinding
+ * @param keysArray
+ * @param valueArrayBinding
+ * @param valueArray
+ * @param resultLimit maximum number of entries to read, -1 for no limit
+ * @return the number of entries read
+ * @throws AccessorException
+ */
+ int getEntries(Binding keyBinding, Object from, boolean fromInclusive, Object end, boolean endInclusive,
+ ArrayBinding keyArrayBinding, Object keysArray,
+ ArrayBinding valueArrayBinding, Object valueArray,
+ int resultLimit) throws AccessorException;
/**
* Get all keys in order
* @return an array of values
* @throws AccessorException
*/
- Object[] getValues(Binding valueBinding) throws AccessorException;\r
+ Object[] getValues(Binding valueBinding) throws AccessorException;
/**
* Get an accessor to a value. It becomes invalid if the entry is
Code Review / simantics / platform.git / blobdiff