Module com.github.robtimus.filesystems

Package com.github.robtimus.filesystems.attribute

Class FileAttributeViewCollection

java.lang.Object

com.github.robtimus.filesystems.attribute.FileAttributeViewCollection

public final class FileAttributeViewCollection
extends Object

An immutable collection of file attribute views. Each view is represented as a FileAttributeViewMetadata object. Instances of this class can be used to implement several methods in FileStore, FileSystem and FileSystemProvider.

Author:

Rob Spoor

Since:

2.2

Method Summary

Modifier and Type	Method	Description
boolean	containsView(Class<? extends FileAttributeView> type)	Returns whether or not this collection contains a specific view.
boolean	containsView(String name)	Returns whether or not this collection contains a specific view.
FileAttributeViewMetadata	getView(String name)	Returns a FileAttributeViewMetadata object representing a specific view.
String	toString()
Set<String>	viewNames()	Returns the names of all contained views.
static FileAttributeViewCollection	withViews(FileAttributeViewMetadata... views)	Creates a new collection of file attribute views.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

withViews

public static FileAttributeViewCollection withViews(FileAttributeViewMetadata... views)

Creates a new collection of file attribute views.

Parameters:

views - The FileAttributeViewMetadata objects representing the views in the created collection.

Returns:

The created collection.

Throws:

NullPointerException - If any of the given FileAttributeViewMetadata objects is null.

IllegalStateException - If any of the FileAttributeViewMetadata objects have duplicate view names.

containsView

public boolean containsView(Class<? extends FileAttributeView> type)

Returns whether or not this collection contains a specific view.

Parameters:

type - The type of file attribute view to check.

Returns:

true if this collection contains the given view, or false otherwise.

See Also:

FileStore.supportsFileAttributeView(Class)

containsView

public boolean containsView(String name)

Returns whether or not this collection contains a specific view.

Parameters:

name - The name of the file attribute view to check.

Returns:

true if this collection contains the given view, or false otherwise.

See Also:

FileStore.supportsFileAttributeView(String)

viewNames

public Set<String> viewNames()

Returns the names of all contained views.

Returns:

An unmodifiable set with the names of all contained views.

See Also:

FileSystem.supportedFileAttributeViews()

getView

public FileAttributeViewMetadata getView(String name)

Returns a FileAttributeViewMetadata object representing a specific view.

Parameters:

name - The name of the view to return a FileAttributeViewMetadata object for.

Returns:

A FileAttributeViewMetadata object representing the given view.

Throws:

UnsupportedOperationException - If no view with the given name is contained in this collection.

See Also:

containsView(String)

toString

public String toString()

Overrides:

toString in class Object