Package com.inductiveautomation.ignition.common.resourcecollection

Class ResourceBuilder

java.lang.Object

com.inductiveautomation.ignition.common.resourcecollection.ResourceBuilder

public class ResourceBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
Resource	build()
ResourceBuilder	clearAttributes()
ResourceBuilder	clearData()	Remove all data files that this builder contains.
ResourceBuilder	copyFrom(Resource resource)	Copy the values from resource into this ResourceBuilder.
ResourceBuilder	putAttribute(String key, boolean value)
ResourceBuilder	putAttribute(String key, int value)
ResourceBuilder	putAttribute(String key, long value)
ResourceBuilder	putAttribute(String key, com.inductiveautomation.ignition.common.gson.JsonElement value)
ResourceBuilder	putAttribute(String key, String value)
ResourceBuilder	putData(byte[] data)
ResourceBuilder	putData(ImmutableBytes data)
ResourceBuilder	putData(String string)	Puts a string into the data map.
ResourceBuilder	putData(String name, byte[] data)
ResourceBuilder	putData(String name, ImmutableBytes data)
ResourceBuilder	putData(String name, String string)	Puts a string into the data map.
ResourceBuilder	removeAttribute(String key)
ResourceBuilder	removeData(String name)
ResourceBuilder	setApplicationScope(int scope)
ResourceBuilder	setApplicationScope(String scope)
ResourceBuilder	setAttributes(Map<String,com.inductiveautomation.ignition.common.gson.JsonElement> attributes)
ResourceBuilder	setData(Map<String,ImmutableBytes> data)	Sets (overwrites) the entire data map.
ResourceBuilder	setDataBytes(Map<String,byte[]> data)	Sets (overwrites) the entire data map.
ResourceBuilder	setDocumentation(String documentation)
ResourceBuilder	setFolder(boolean folder)
ResourceBuilder	setOverridable(boolean overridable)
ResourceBuilder	setResourceCollectionName(String collectionName)
ResourceBuilder	setResourceId(ResourceId id)
ResourceBuilder	setResourcePath(ResourcePath resourcePath)
ResourceBuilder	setRestricted(boolean restricted)
ResourceBuilder	setUnary(boolean unary)	Marking a resource as unary affects how it is encoded on-disk.
ResourceBuilder	setVersion(int version)

Methods inherited from class java.lang.Object

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

Method Details

copyFrom

public ResourceBuilder copyFrom(Resource resource)

Copy the values from resource into this ResourceBuilder.

Parameters:

resource - the Resource to copy from.

Returns:

this ResourceBuilder.

setResourceId

public ResourceBuilder setResourceId(ResourceId id)

setResourceCollectionName

public ResourceBuilder setResourceCollectionName(String collectionName)

setResourcePath

public ResourceBuilder setResourcePath(ResourcePath resourcePath)

setDocumentation

public ResourceBuilder setDocumentation(String documentation)

setDataBytes

public ResourceBuilder setDataBytes(@Nonnull
 Map<String,byte[]> data)

Sets (overwrites) the entire data map. Byte values will be copied into ImmutableBytes

setData

public ResourceBuilder setData(@Nonnull
 Map<String,ImmutableBytes> data)

Sets (overwrites) the entire data map.

putData

public ResourceBuilder putData(@Nonnull
 byte[] data)

putData

public ResourceBuilder putData(@Nonnull
 String string)

Puts a string into the data map. The string will be converted to bytes using UTF-8.

putData

public ResourceBuilder putData(@Nonnull
 ImmutableBytes data)

putData

public ResourceBuilder putData(@Nonnull
 String name,
 @Nonnull
 byte[] data)

putData

public ResourceBuilder putData(@Nonnull
 String name,
 @Nonnull
 String string)

Puts a string into the data map. The string will be converted to bytes using UTF-8.

putData

public ResourceBuilder putData(@Nonnull
 String name,
 @Nonnull
 ImmutableBytes data)

removeData

public ResourceBuilder removeData(@Nonnull
 String name)

clearData

public ResourceBuilder clearData()

Remove all data files that this builder contains.

setAttributes

public ResourceBuilder setAttributes(@Nonnull
 Map<String,com.inductiveautomation.ignition.common.gson.JsonElement> attributes)

putAttribute

public ResourceBuilder putAttribute(String key,
 boolean value)

putAttribute

public ResourceBuilder putAttribute(String key,
 int value)

putAttribute

public ResourceBuilder putAttribute(String key,
 long value)

putAttribute

public ResourceBuilder putAttribute(String key,
 String value)

putAttribute

public ResourceBuilder putAttribute(String key,
 com.inductiveautomation.ignition.common.gson.JsonElement value)

removeAttribute

public ResourceBuilder removeAttribute(@Nonnull
 String key)

clearAttributes

public ResourceBuilder clearAttributes()

setApplicationScope

public ResourceBuilder setApplicationScope(int scope)

setApplicationScope

public ResourceBuilder setApplicationScope(String scope)

setRestricted

public ResourceBuilder setRestricted(boolean restricted)

setOverridable

public ResourceBuilder setOverridable(boolean overridable)

setVersion

public ResourceBuilder setVersion(int version)

setFolder

public ResourceBuilder setFolder(boolean folder)

setUnary

public ResourceBuilder setUnary(boolean unary)

Marking a resource as unary affects how it is encoded on-disk. Folders may contain only one unary resource, whose name must be "_unary". The files for this resource will be stored directly in the folder, saving a level of directory nesting.

build

public Resource build()