Package org.godot.utilities.project.resources

Class ProjectResource

java.lang.Object

org.godot.utilities.core.io.FileResource

org.godot.utilities.project.resources.ProjectResource

All Implemented Interfaces:

IResource

Direct Known Subclasses:

Scene

public class ProjectResource
extends FileResource

Field Summary

Fields

Modifier and Type	Field	Description
protected Ini	contentFile	Content file
boolean	isDisplayable	Check if file is displayable (only pictures with specific formats)
boolean	isReadable	Check if file is readable (only files with .ini syntax)
ResourceType	resourceType	Current resource type
Version	version	Project version

Fields inherited from class org.godot.utilities.core.io.FileResource

location

Constructor Summary

Constructors

Constructor	Description
ProjectResource(@NotNull Path l, @NotNull Version v)	ProjectResource constructor.
ProjectResource(@NotNull Path l, @NotNull Project p)	ProjectResource constructor.

Method Summary

Modifier and Type	Method	Description
Ini	getFileContent()	Get file content only if current file is readable.
@NotNull String	toString()	Object string representation
void	updateContent()	The same behavior of getFileContent() but this method return nothing.

Methods inherited from class org.godot.utilities.core.io.FileResource

getExtension, getResourcePath

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.godot.utilities.core.io.IResource

exists

Field Detail

version

public final Version version

Project version

isReadable

public final boolean isReadable

Check if file is readable (only files with .ini syntax)

isDisplayable

public final boolean isDisplayable

Check if file is displayable (only pictures with specific formats)

resourceType

public final ResourceType resourceType

Current resource type

contentFile

protected Ini contentFile

Content file

Constructor Detail

ProjectResource

public ProjectResource(@NotNull
                       @NotNull Path l,
                       @NotNull
                       @NotNull Version v)

ProjectResource constructor.

Parameters:

l - Target resource location

v - Target resource version

ProjectResource

public ProjectResource(@NotNull
                       @NotNull Path l,
                       @NotNull
                       @NotNull Project p)

ProjectResource constructor.

Parameters:

l - Target resource location

p - Target project container

Method Detail

getFileContent

public Ini getFileContent()
                   throws IOException

Get file content only if current file is readable.

Returns:

Return an ini file with all content in INI format.

Throws:

UnsupportedOperationException - Error if operation is not supported

IOException - Error if file not exists or is not a valid file

updateContent

public void updateContent()
                   throws IOException

The same behavior of getFileContent() but this method return nothing.

Throws:

UnsupportedOperationException - Error if operation is not supported

IOException - Error if file not exists or is not a valid file

toString

@NotNull
public @NotNull String toString()

Object string representation

Overrides:

toString in class FileResource

Returns:

Object string representation