-/*******************************************************************************\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.file;
-import java.io.File;\r
-\r
-import org.simantics.databoard.accessor.Accessor;\r
-import org.simantics.databoard.accessor.CloseableAccessor;\r
-import org.simantics.databoard.accessor.binary.BinaryObject;\r
-import org.simantics.databoard.accessor.error.AccessorException;\r
-import org.simantics.databoard.binding.Binding;\r
-\r
-/**\r
- * File accessor is an interface for data that is located in a file in byte format.\r
- * There are two ways of writing to the files. \r
- * A) Using the writing methods of Accessor+subtypes, eg. setValue, putValue, ...\r
- * They guarantee the value is flushed to the file upon return\r
- * B) Using the write methods of FileAccessor+subtypes, eg. setValueNoflush, putValueNoflush ...\r
- * They do not guarantee flush upon return. Explicit flush() call is required.\r
- * The value resides in memory cache and are available for reading event before flushing.\r
- *\r
- * see FileAccessorExample\r
- * @see BinaryObject File/Memory Byte[] implementation\r
- * @see FileArrayAccessor\r
- * @see FileBooleanAccessor\r
- * @see FileByteAccessor\r
- * @see FileDoubleAccessor\r
- * @see FileFloatAccessor\r
- * @see FileIntegerAccessor\r
- * @see FileLongAccessor\r
- * @see FileMapAccessor\r
- * @see FileOptionalAccessor\r
- * @see FileRecordAccessor\r
- * @see FileStringAccessor\r
- * @see FileUnionAccessor\r
- * @see FileVariantAccessor\r
- * @author Toni Kalajainen <toni.kalajainen@vtt.fi>\r
+import java.io.File;
+
+import org.simantics.databoard.accessor.Accessor;
+import org.simantics.databoard.accessor.CloseableAccessor;
+import org.simantics.databoard.accessor.binary.BinaryObject;
+import org.simantics.databoard.accessor.error.AccessorException;
+import org.simantics.databoard.binding.Binding;
+
+/**
+ * File accessor is an interface for data that is located in a file in byte format.
+ * There are two ways of writing to the files.
+ * A) Using the writing methods of Accessor+subtypes, eg. setValue, putValue, ...
+ * They guarantee the value is flushed to the file upon return
+ * B) Using the write methods of FileAccessor+subtypes, eg. setValueNoflush, putValueNoflush ...
+ * They do not guarantee flush upon return. Explicit flush() call is required.
+ * The value resides in memory cache and are available for reading event before flushing.
+ *
+ * see FileAccessorExample
+ * @see BinaryObject File/Memory Byte[] implementation
+ * @see FileArrayAccessor
+ * @see FileBooleanAccessor
+ * @see FileByteAccessor
+ * @see FileDoubleAccessor
+ * @see FileFloatAccessor
+ * @see FileIntegerAccessor
+ * @see FileLongAccessor
+ * @see FileMapAccessor
+ * @see FileOptionalAccessor
+ * @see FileRecordAccessor
+ * @see FileStringAccessor
+ * @see FileUnionAccessor
+ * @see FileVariantAccessor
+ * @author Toni Kalajainen <toni.kalajainen@vtt.fi>
*/
public interface FileAccessor extends Accessor, CloseableAccessor {
* @throws AccessorException
*/
void flush() throws AccessorException;
- \r
- /**\r
- * Reset internal buffer. If there unwritten changes, they are flushed.\r
- * \r
- * @throws AccessorException\r
- */\r
- void reset() throws AccessorException;\r
+
+ /**
+ * Reset internal buffer. If there unwritten changes, they are flushed.
+ *
+ * @throws AccessorException
+ */
+ void reset() throws AccessorException;
/**
* Write a value to the file without flushing the writebuffer yet.
* @param newValue
* @throws AccessorException
*/
- void setValueNoflush(Binding binding, Object newValue) throws AccessorException;\r
- \r
+ void setValueNoflush(Binding binding, Object newValue) throws AccessorException;
+
}