generated.docs.javadoc.org.eclipse.dawnsci.nexus.builder.NexusScanFile.html Maven / Gradle / Ivy






NexusScanFile (h5jan API)











Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.nexus.builder
Interface NexusScanFile






All Superinterfaces:
java.lang.AutoCloseable




public interface NexusScanFile
extends java.lang.AutoCloseable
Represents a NeXus file built using this framework. The structure
 of the file has been created and cannot be further modified.
 Writable datasets can to be written to the file.











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


void
close()
Flushes and closes the underlying NexusFile.



int
flush()
Flushes the underlying NexusFile.



void
openToWrite()
Opens the file to write.
















Method Detail





openToWrite
void openToWrite()
          throws NexusException
Opens the file to write. SWMR mode is also enabled.

Throws:
NexusException - if the file could not be opened for any reason








flush
int flush()
   throws NexusException
Flushes the underlying NexusFile.

Throws:
NexusException - if the nexus file could not be flushed for any reason








close
void close()
    throws NexusException
Flushes and closes the underlying NexusFile.

Specified by:
close in interface java.lang.AutoCloseable
Throws:
NexusException - if the nexus file could not be closed for an reason














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method

Modifier and Type	Method and Description
`void`	`close()` Flushes and closes the underlying `NexusFile`.
`int`	`flush()` Flushes the underlying `NexusFile`.
`void`	`openToWrite()` Opens the file to write.