Module com.github.robtimus.filesystems

Package com.github.robtimus.filesystems.attribute

Class FileAttributeViewMetadata.Builder

java.lang.Object

com.github.robtimus.filesystems.attribute.FileAttributeViewMetadata.Builder

Enclosing class:

FileAttributeViewMetadata

public static final class FileAttributeViewMetadata.Builder
extends Object

A builder for FileAttributeViewMetadata objects.

Author:

Rob Spoor

Since:

2.2

Method Summary

Modifier and Type	Method	Description
FileAttributeViewMetadata	build()	Creates a FileAttributeViewMetadata object with the attributes added to this builder.
static Type	returnType(Class<?> declaringType, String methodName, Class<?>... parameterTypes)	Returns a Type representing the return type of an existing public method.
FileAttributeViewMetadata.Builder	withAttribute(String attributeName, Type attributeType)	Adds a single attribute that is both readable and writable.
FileAttributeViewMetadata.Builder	withAttribute(String attributeName, Type attributeType, FileAttributeViewMetadata.Operation firstOperation, FileAttributeViewMetadata.Operation... additionalOperations)	Adds a single attribute that is only supported for specific operations.
FileAttributeViewMetadata.Builder	withAttributes(FileAttributeViewMetadata view)	Adds all attributes of another FileAttributeViewMetadata object.
FileAttributeViewMetadata.Builder	withViewName(String viewName)	Sets the view name to use.

Methods inherited from class java.lang.Object

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

Method Detail

withViewName

public FileAttributeViewMetadata.Builder withViewName(String viewName)

Sets the view name to use. The default view name is derived from the view type as follows:

• If the view type's simple name ends with FileAttributeView, the part before it in camel case.
• If the view type's simple name ends with AttributeView, the part before it in camel case.
• If the view type's simple name ends with View, the part before it in camel case.
• The view type's simple name in camel case.

Parameters:

viewName - The view name to use.

Returns:

This builder.

Throws:

NullPointerException - If the given view name is null.

IllegalArgumentException - If the given view name is empty.

withAttribute

public FileAttributeViewMetadata.Builder withAttribute(String attributeName,
                                                       Type attributeType)

Adds a single attribute that is both readable and writable.

Parameters:

attributeName - The name of the attribute to add.

attributeType - The type of the attribute to add. This should usually be a class literal, or the result of calling returnType(Class, String, Class...) for generic types.

Returns:

This object.

Throws:

NullPointerException - If the given attribute name or type is null.

withAttribute

public FileAttributeViewMetadata.Builder withAttribute(String attributeName,
                                                       Type attributeType,
                                                       FileAttributeViewMetadata.Operation firstOperation,
                                                       FileAttributeViewMetadata.Operation... additionalOperations)

Adds a single attribute that is only supported for specific operations.

Parameters:

attributeName - The name of the attribute to add.

attributeType - The type of the attribute to add. This should usually be a class literal, or the result of calling returnType(Class, String, Class...) for generic types.

firstOperation - The first operation for which the attribute is supported.

additionalOperations - Zero or more additional operations for which the attribute is supported.

Returns:

This object.

Throws:

NullPointerException - If the given attribute name or type or any of the operations is null.

withAttributes

public FileAttributeViewMetadata.Builder withAttributes(FileAttributeViewMetadata view)

Adds all attributes of another FileAttributeViewMetadata object. This can be used when one FileAttributeView interface extends from another.

Parameters:

view - The FileAttributeViewMetadata object to add all attributes of.

Returns:

This object.

Throws:

NullPointerException - If the given FileAttributeViewMetadata object is null.

build

public FileAttributeViewMetadata build()

Creates a FileAttributeViewMetadata object with the attributes added to this builder.

Returns:

The created FileAttributeViewMetadata object.

returnType

public static Type returnType(Class<?> declaringType,
                              String methodName,
                              Class<?>... parameterTypes)

Returns a Type representing the return type of an existing public method.

Parameters:

declaringType - The class or interface where the method is declared.

methodName - The name of the method.

parameterTypes - The parameter types of the method.

Returns:

A Type representing the return type of the requested method.

Throws:

NullPointerException - If the given declaring type or method name is null.

IllegalArgumentException - If the requested method does not exist.