com.neeve.server.mon
Interface ISrvMonSysDiskStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonSysDiskStats

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonSysDiskStats
extends IRogValidatable

Groups together stats related to the disk available for the XVM.

Method Summary

void	clearFreeSpace() Clears the value of 'freeSpace' Field Description Returns the number of unallocated bytes in the disk or partition.
void	clearRootPath() Clears the value of 'rootPath' Field Description The file system root path for the disk or partition.
void	clearTotalSpace() Clears the value of 'totalSpace' Field Description The size, in bytes, of the partition or 0L if the root path doesn't correspond to a partition.
void	clearUsableSpace() Clears the value of 'usableSpace' Field Description The number of bytes available to the xvm for the disk or partition.
long	getFreeSpace() Gets the value of 'freeSpace' Field Description Returns the number of unallocated bytes in the disk or partition.
String	getRootPath() Gets the value of 'rootPath' Field Description The file system root path for the disk or partition.
<T extends XString> T	getRootPathTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getRootPathTo(XString val) Copies the value of 'rootPath' into the provided XString.
XString	getRootPathUnsafe() Gets the raw value of 'rootPath'.
long	getTotalSpace() Gets the value of 'totalSpace' Field Description The size, in bytes, of the partition or 0L if the root path doesn't correspond to a partition.
long	getUsableSpace() Gets the value of 'usableSpace' Field Description The number of bytes available to the xvm for the disk or partition.
boolean	hasFreeSpace() Checks for the presence of 'freeSpace' Field Description Returns the number of unallocated bytes in the disk or partition.
boolean	hasRootPath() Checks for the presence of 'rootPath' Field Description The file system root path for the disk or partition.
boolean	hasTotalSpace() Checks for the presence of 'totalSpace' Field Description The size, in bytes, of the partition or 0L if the root path doesn't correspond to a partition.
boolean	hasUsableSpace() Checks for the presence of 'usableSpace' Field Description The number of bytes available to the xvm for the disk or partition.
void	lendRootPath(XString val) Sets the value of 'rootPath' Field Description The file system root path for the disk or partition.
void	setFreeSpace(long val) Sets the value of 'freeSpace' Field Description Returns the number of unallocated bytes in the disk or partition.
void	setRootPath(String val) Sets the value of 'rootPath' Field Description The file system root path for the disk or partition.
void	setRootPathFrom(long val) Sets the value of this String field to the given numeric value.
void	setRootPathFrom(XString val) Copies the provided XString value into this object's 'rootPath'.
void	setTotalSpace(long val) Sets the value of 'totalSpace' Field Description The size, in bytes, of the partition or 0L if the root path doesn't correspond to a partition.
void	setUsableSpace(long val) Sets the value of 'usableSpace' Field Description The number of bytes available to the xvm for the disk or partition.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setTotalSpace

void setTotalSpace(long val)

Sets the value of 'totalSpace'

Field Description

The size, in bytes, of the partition or 0L if the root path doesn't correspond to a partition.

Parameters:

val - The value to set.

getTotalSpace

long getTotalSpace()

Gets the value of 'totalSpace'

Field Description

The size, in bytes, of the partition or 0L if the root path doesn't correspond to a partition.

Returns:

The size, in bytes, of the partition or 0L if the root path doesn't correspond to a partition.

clearTotalSpace

void clearTotalSpace()

Clears the value of 'totalSpace'

Field Description

The size, in bytes, of the partition or 0L if the root path doesn't correspond to a partition.

See Also:

setTotalSpace(long)

hasTotalSpace

boolean hasTotalSpace()

Checks for the presence of 'totalSpace'

Field Description

The size, in bytes, of the partition or 0L if the root path doesn't correspond to a partition.

See Also:

getTotalSpace()

setUsableSpace

void setUsableSpace(long val)

Sets the value of 'usableSpace'

Field Description

The number of bytes available to the xvm for the disk or partition.

Parameters:

val - The value to set.

getUsableSpace

long getUsableSpace()

Gets the value of 'usableSpace'

Field Description

The number of bytes available to the xvm for the disk or partition.

Returns:

The number of bytes available to the xvm for the disk or partition.

clearUsableSpace

void clearUsableSpace()

Clears the value of 'usableSpace'

Field Description

The number of bytes available to the xvm for the disk or partition.

See Also:

setUsableSpace(long)

hasUsableSpace

boolean hasUsableSpace()

Checks for the presence of 'usableSpace'

Field Description

The number of bytes available to the xvm for the disk or partition.

See Also:

getUsableSpace()

setFreeSpace

void setFreeSpace(long val)

Sets the value of 'freeSpace'

Field Description

Returns the number of unallocated bytes in the disk or partition.

Parameters:

val - The value to set.

getFreeSpace

long getFreeSpace()

Gets the value of 'freeSpace'

Field Description

Returns the number of unallocated bytes in the disk or partition.

Returns:

Returns the number of unallocated bytes in the disk or partition.

clearFreeSpace

void clearFreeSpace()

Clears the value of 'freeSpace'

Field Description

Returns the number of unallocated bytes in the disk or partition.

See Also:

setFreeSpace(long)

hasFreeSpace

boolean hasFreeSpace()

Checks for the presence of 'freeSpace'

Field Description

Returns the number of unallocated bytes in the disk or partition.

See Also:

getFreeSpace()

setRootPath

void setRootPath(String val)

Sets the value of 'rootPath'

Field Description

The file system root path for the disk or partition.

Parameters:

val - The value to set.

getRootPath

String getRootPath()

Gets the value of 'rootPath'

Field Description

The file system root path for the disk or partition.

Returns:

The file system root path for the disk or partition.

lendRootPath

void lendRootPath(XString val)

Sets the value of 'rootPath'

Field Description

The file system root path for the disk or partition.

Parameters:

val - The value to set.

setRootPathFrom

void setRootPathFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The file system root path for the disk or partition.

NOTE:
This is the same as calling setRootPath(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getRootPathTo

<T extends XString> T getRootPathTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The file system root path for the disk or partition.

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setRootPathFrom

void setRootPathFrom(XString val)

Copies the provided XString value into this object's 'rootPath'.

Field Description

The file system root path for the disk or partition.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setRootPath(String) because it avoids encoding the value into a String if the given XString is already encoded.

getRootPathTo

void getRootPathTo(XString val)

Copies the value of 'rootPath' into the provided XString.

Field Description

The file system root path for the disk or partition.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getRootPath() bec because it can avoid decoding the value into an String.

See Also:

getRootPath()

getRootPathUnsafe

XString getRootPathUnsafe()

Gets the raw value of 'rootPath'.

Field Description

The file system root path for the disk or partition.

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Returns:

the field's raw value

See Also:

getRootPath()

clearRootPath

void clearRootPath()

Clears the value of 'rootPath'

Field Description

The file system root path for the disk or partition.

See Also:

setRootPath(String)

hasRootPath

boolean hasRootPath()

Checks for the presence of 'rootPath'

Field Description

The file system root path for the disk or partition.

See Also:

getRootPath()