FolderSnapshot (worldedit-core 7.2.0 API)

java.lang.Object
- com.sk89q.worldedit.world.snapshot.experimental.fs.FolderSnapshot

All Implemented Interfaces:

Snapshot, java.io.Closeable, java.lang.AutoCloseable
```
public class FolderSnapshot
extends java.lang.Object
implements Snapshot
```
Snapshot based on a world folder. Extracts chunks from the region folder.
Note that the Path can belong to another filesystem. This allows easy integration with zips due to Java's built-in zipfs support.

Constructor Summary

Constructors
Constructor and Description

FolderSnapshot(SnapshotInfo info, java.nio.file.Path folder, Closer closeCallback)

Constructors
Constructor and Description
`FolderSnapshot(SnapshotInfo info, java.nio.file.Path folder, Closer closeCallback)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close this snapshot.
`CompoundTag`	`getChunkTag(BlockVector3 position)` Get the chunk information for the given position.
`java.nio.file.Path`	`getFolder()`
`SnapshotInfo`	`getInfo()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sk89q.worldedit.world.snapshot.experimental.Snapshot
getChunk

- Constructor Detail
  - FolderSnapshot
```
public FolderSnapshot(SnapshotInfo info,
                      java.nio.file.Path folder,
                      @Nullable
                      Closer closeCallback)
```
- Method Detail
  - getFolder
```
public java.nio.file.Path getFolder()
```
  - getInfo
```
public SnapshotInfo getInfo()
```
    Specified by:
    
    getInfo in interface Snapshot
  - getChunkTag
```
public CompoundTag getChunkTag(BlockVector3 position)
                        throws DataException,
                               java.io.IOException
```
    Description copied from interface: Snapshot
    
    Get the chunk information for the given position. Implementations may ignore the Y-chunk if its chunks are only stored in 2D.
    
    Specified by:
    
    getChunkTag in interface Snapshot
    
    Parameters:
    
    position - the position of the chunk
    
    Returns:
    
    the tag containing chunk data
    
    Throws:
    
    DataException
    
    java.io.IOException
  - close
```
public void close()
           throws java.io.IOException
```
    Description copied from interface: Snapshot
    
    Close this snapshot. This releases the IO handles used to load chunk information.
    
    Specified by:
    
    close in interface Snapshot
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException

Class FolderSnapshot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.sk89q.worldedit.world.snapshot.experimental.Snapshot

Constructor Detail

FolderSnapshot

Method Detail

getFolder

getInfo

getChunkTag

close