com.neeve.server.mon

Interface ISrvMonSysDiskStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonSysDiskStats

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
public interface ISrvMonSysDiskStats
extends IRogValidatable

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

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
freeSpace	Long	4	Returns the number of unallocated bytes in the disk or partition.
rootPath	String	1	The file system root path for the disk or partition.
totalSpace	Long	2	The size, in bytes, of the partition or 0L if the root path doesn't correspond to a partition.
usableSpace	Long	3	The number of bytes available to the xvm for the disk or partition.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearFreeSpace() Clears the value of 'freeSpace'.
void	clearRootPath() Clears the value of 'rootPath'.
void	clearTotalSpace() Clears the value of 'totalSpace'.
void	clearUsableSpace() Clears the value of 'usableSpace'.
long	getFreeSpace() Gets the value of 'freeSpace'.
String	getRootPath() Gets the value of 'rootPath'.
<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'.
long	getUsableSpace() Gets the value of 'usableSpace'.
boolean	hasFreeSpace() Checks for the presence of 'freeSpace'.
boolean	hasRootPath() Checks for the presence of 'rootPath'.
boolean	hasTotalSpace() Checks for the presence of 'totalSpace'.
boolean	hasUsableSpace() Checks for the presence of 'usableSpace'.
void	lendRootPath(XString val) Lends the value of 'rootPath' to this object.
void	setFreeSpace(long val) Sets the value of 'freeSpace'.
void	setRootPath(String val) Sets the value of 'rootPath'.
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'.
void	setUsableSpace(long val) Sets the value of 'usableSpace'.

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)

Lends the value of 'rootPath' to this object.

This method is equivalent to setRootPath except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The file system root path for the disk or partition.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

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()