SnapshotRepository (worldedit-core 7.2.0 API)

java.lang.Object
- com.sk89q.worldedit.world.snapshot.SnapshotRepository

public class SnapshotRepository
extends java.lang.Object

A repository contains zero or more snapshots.

Field Summary

Fields
Modifier and Type Field and Description

protected java.util.List<SnapshotDateParser> dateParsers

protected java.io.File dir

Fields
Modifier and Type	Field and Description
`protected java.util.List<SnapshotDateParser>`	`dateParsers`
`protected java.io.File`	`dir`

Constructor Summary

Constructors
Constructor and Description
`SnapshotRepository(java.io.File dir)` Create a new instance of a repository.
`SnapshotRepository(java.lang.String dir)` Create a new instance of a repository.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`detectDate(Snapshot snapshot)` Attempt to detect a snapshot's date and assign it.
`Snapshot`	`getDefaultSnapshot(java.lang.String world)` Get the default snapshot.
`java.io.File`	`getDirectory()` Get the snapshot directory.
`Snapshot`	`getSnapshot(java.lang.String name)` Get a snapshot.
`Snapshot`	`getSnapshotAfter(java.time.ZonedDateTime date, java.lang.String world)` Get the first snapshot after a date.
`Snapshot`	`getSnapshotBefore(java.time.ZonedDateTime date, java.lang.String world)` Get the first snapshot before a date.
`java.util.List<Snapshot>`	`getSnapshots(boolean newestFirst, java.lang.String worldName)` Get a list of snapshots in a directory.
`protected boolean`	`isValidSnapshot(java.io.File file)` Check to see if a snapshot is valid.
`boolean`	`isValidSnapshotName(java.lang.String snapshot)` Check to see if a snapshot is valid.

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

- Field Detail
  - dir
```
protected java.io.File dir
```
  - dateParsers
```
protected java.util.List<SnapshotDateParser> dateParsers
```
- Constructor Detail
  - SnapshotRepository
```
public SnapshotRepository(java.io.File dir)
```
    Create a new instance of a repository.
    
    Parameters:
    
    dir - the directory
  - SnapshotRepository
```
public SnapshotRepository(java.lang.String dir)
```
    Create a new instance of a repository.
    
    Parameters:
    
    dir - the directory
- Method Detail
  - getSnapshots
```
public java.util.List<Snapshot> getSnapshots(boolean newestFirst,
                                             java.lang.String worldName)
                                      throws MissingWorldException
```
    Get a list of snapshots in a directory. The newest snapshot is near the top of the array.
    
    Parameters:
    
    newestFirst - true to get the newest first
    
    Returns:
    
    a list of snapshots
    
    Throws:
    
    MissingWorldException
  - getSnapshotAfter
```
@Nullable
public Snapshot getSnapshotAfter(java.time.ZonedDateTime date,
                                           java.lang.String world)
                                    throws MissingWorldException
```
    Get the first snapshot after a date.
    
    Parameters:
    
    date - a date
    
    Returns:
    
    a snapshot or null
    
    Throws:
    
    MissingWorldException
  - getSnapshotBefore
```
@Nullable
public Snapshot getSnapshotBefore(java.time.ZonedDateTime date,
                                            java.lang.String world)
                                     throws MissingWorldException
```
    Get the first snapshot before a date.
    
    Parameters:
    
    date - a date
    
    Returns:
    
    a snapshot or null
    
    Throws:
    
    MissingWorldException
  - detectDate
```
protected void detectDate(Snapshot snapshot)
```
    Attempt to detect a snapshot's date and assign it.
    
    Parameters:
    
    snapshot - the snapshot
  - getDefaultSnapshot
```
@Nullable
public Snapshot getDefaultSnapshot(java.lang.String world)
                                      throws MissingWorldException
```
    Get the default snapshot.
    
    Parameters:
    
    world - the world name
    
    Returns:
    
    a snapshot or null
    
    Throws:
    
    MissingWorldException
  - isValidSnapshotName
```
public boolean isValidSnapshotName(java.lang.String snapshot)
```
    Check to see if a snapshot is valid.
    
    Parameters:
    
    snapshot - a snapshot name
    
    Returns:
    
    whether it is a valid snapshot
  - isValidSnapshot
```
protected boolean isValidSnapshot(java.io.File file)
```
    Check to see if a snapshot is valid.
    
    Parameters:
    
    file - the file to the snapshot
    
    Returns:
    
    whether it is a valid snapshot
  - getSnapshot
```
public Snapshot getSnapshot(java.lang.String name)
                     throws InvalidSnapshotException
```
    Get a snapshot.
    
    Parameters:
    
    name - the name of the snapshot
    
    Returns:
    
    a snapshot
    
    Throws:
    
    InvalidSnapshotException - if the snapshot is invalid
  - getDirectory
```
public java.io.File getDirectory()
```
    Get the snapshot directory.
    
    Returns:
    
    a path

Class SnapshotRepository

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dir

dateParsers

Constructor Detail

SnapshotRepository

SnapshotRepository

Method Detail

getSnapshots

getSnapshotAfter

getSnapshotBefore

detectDate

getDefaultSnapshot

isValidSnapshotName

isValidSnapshot

getSnapshot

getDirectory