OSProcess (oshi-core 4.0.0 API)

java.lang.Object
- oshi.software.os.OSProcess

All Implemented Interfaces:

Serializable
```
public class OSProcess
extends Object
implements Serializable
```
A process is an instance of a computer program that is being executed. It contains the program code and its current activity. Depending on the operating system (OS), a process may be made up of multiple threads of execution that execute instructions concurrently.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OSProcess.State
Process Execution States

Nested Classes
Modifier and Type	Class and Description
`static class`	`OSProcess.State` Process Execution States

Constructor Summary

Constructors
Constructor and Description

OSProcess()

Constructors
Constructor and Description
`OSProcess()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`calculateCpuPercent()` Calculates CPU usage of this process.
`int`	`getBitness()` Attempts to get the bitness (32 or 64) of the process.
`long`	`getBytesRead()` Getter for the field `bytesRead`.
`long`	`getBytesWritten()` Getter for the field `bytesWritten`.
`String`	`getCommandLine()` Getter for the field `commandLine`.
`String`	`getCurrentWorkingDirectory()` Getter for the field `currentWorkingDirectory`.
`String`	`getGroup()` Getter for the field `group`.
`String`	`getGroupID()` Getter for the field `groupID`.
`long`	`getKernelTime()` Getter for the field `kernelTime`.
`String`	`getName()` Getter for the field `name`.
`long`	`getOpenFiles()` Sets the number of open file handles (or network connections) that belongs to the process On FreeBSD and Solaris, this value is only populated if information for a single process id is requested.
`int`	`getParentProcessID()` Getter for the field `parentProcessID`.
`String`	`getPath()` Getter for the field `path`.
`int`	`getPriority()` Getter for the field `priority`.
`int`	`getProcessID()` Getter for the field `processID`.
`long`	`getResidentSetSize()` Getter for the field `residentSetSize`.
`long`	`getStartTime()` Getter for the field `startTime`.
`OSProcess.State`	`getState()` Getter for the field `state`.
`int`	`getThreadCount()` Getter for the field `threadCount`.
`long`	`getUpTime()` Getter for the field `upTime`.
`String`	`getUser()` Getter for the field `user`.
`String`	`getUserID()` Getter for the field `userID`.
`long`	`getUserTime()` Getter for the field `userTime`.
`long`	`getVirtualSize()` Getter for the field `virtualSize`.
`void`	`setBitness(int bitness)` Setter for the field `bitness`.
`void`	`setBytesRead(long bytesRead)` Set the number of bytes the process has read from disk.
`void`	`setBytesWritten(long bytesWritten)` Set the number of bytes the process has written to disk.
`void`	`setCommandLine(String commandLine)` Sets the process command line.
`void`	`setCurrentWorkingDirectory(String currentWorkingDirectory)` Sets the process current working directory
`void`	`setGroup(String group)` Sets the group.
`void`	`setGroupID(String groupID)` Sets the Group ID.
`void`	`setKernelTime(long kernelTime)` Set the number of milliseconds the process has executed in kernel mode.
`void`	`setName(String name)` Set the name of the process.
`void`	`setOpenFiles(long count)` Sets the number of open file handles (or network connections) that belongs to the process
`void`	`setParentProcessID(int parentProcessID)` Set the parentProcessID.
`void`	`setPath(String path)` Set the full path of the executing process.
`void`	`setPriority(int priority)` Set the priority of this process.
`void`	`setProcessID(int processID)` Set the processID.
`void`	`setResidentSetSize(long residentSetSize)` Set the Resident Set Size (RSS).
`void`	`setStartTime(long startTime)` Set the start time of the process in number of milliseconds since January 1, 1970.
`void`	`setState(OSProcess.State state)` Set the execution state of the process.
`void`	`setThreadCount(int threadCount)` Set the number of threads in this process.
`void`	`setUpTime(long upTime)` Set the number of milliseconds since the process started.
`void`	`setUser(String user)` Sets the user.
`void`	`setUserID(String userID)` Sets the User ID.
`void`	`setUserTime(long userTime)` Set the number of milliseconds the process has executed in user mode.
`void`	`setVirtualSize(long virtualSize)` Set the Virtual Memory Size (VSZ).
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OSProcess
```
public OSProcess()
```
- Method Detail
  - getName
```
public String getName()
```
    Getter for the field name.
    
    Returns:
    
    Returns the name of the process.
  - getPath
```
public String getPath()
```
    Getter for the field path.
    
    Returns:
    
    Returns the full path of the executing process.
  - getCommandLine
```
public String getCommandLine()
```
    Getter for the field commandLine.
    
    Returns:
    
    Returns the process command line. The format of this string is platform-dependent and may require the end user to parse the result. On Linux and macOS systems, the string is null-character-delimited, to permit the end user to parse the executable and arguments if desired. Further, the macOS variant may include environment variables which the end user may wish to exclude from display. On Solaris, the string is truncated to 80 characters.
  - getCurrentWorkingDirectory
```
public String getCurrentWorkingDirectory()
```
    Getter for the field currentWorkingDirectory.
    
    Returns:
    
    Returns the process current working directory. On Windows, this value is only populated for the current process.
  - getUser
```
public String getUser()
```
    Getter for the field user.
    
    Returns:
    
    Returns the user name. On Windows systems, also returns the domain prepended to the username.
  - getUserID
```
public String getUserID()
```
    Getter for the field userID.
    
    Returns:
    
    Returns the userID. On Windows systems, returns the Security ID (SID)
  - getGroup
```
public String getGroup()
```
    Getter for the field group.
    
    Returns:
    
    Returns the group. On Windows systems, populating this value for processes other than the current user requires administrative privileges (and still may fail for some system processes) and can incur significant latency. The value is only calculated for single process queries using OperatingSystem.getProcess(int). When successful, returns a comma-delimited list of groups with access to this process, corresponding to the SIDs in getGroupID().
  - getGroupID
```
public String getGroupID()
```
    Getter for the field groupID.
    
    Returns:
    
    Returns the groupID. On Windows systems, populating this value for processes other than the current user requires administrative privileges (and still may fail for some system processes) and can incur significant latency. The value is only calculated for single process queries using OperatingSystem.getProcess(int). When successful, returns a comma-delimited list of group SIDs with access to this process, corresponding to the names in getGroup().
  - getState
```
public OSProcess.State getState()
```
    Getter for the field state.
    
    Returns:
    
    Returns the execution state of the process.
  - getProcessID
```
public int getProcessID()
```
    Getter for the field processID.
    
    Returns:
    
    Returns the processID.
  - getParentProcessID
```
public int getParentProcessID()
```
    Getter for the field parentProcessID.
    
    Returns:
    
    Returns the parentProcessID, if any; 0 otherwise.
  - getThreadCount
```
public int getThreadCount()
```
    Getter for the field threadCount.
    
    Returns:
    
    Returns the number of threads in this process.
  - getPriority
```
public int getPriority()
```
    Getter for the field priority.
    
    Returns:
    
    Returns the priority of this process. For Linux and Unix, priority is a value in the range -20 to 19 (20 on some systems). The default priority is 0; lower priorities cause more favorable scheduling. For Windows, priority values can range from 0 (lowest priority) to 31 (highest priority). Mac OS X has 128 priority levels, ranging from 0 (lowest priority) to 127 (highest priority). They are divided into several major bands: 0 through 51 are the normal levels; the default priority is 31. 52 through 79 are the highest priority regular threads; 80 through 95 are for kernel mode threads; and 96 through 127 correspond to real-time threads, which are treated differently than other threads by the scheduler.
  - getVirtualSize
```
public long getVirtualSize()
```
    Getter for the field virtualSize.
    
    Returns:
    
    Returns the Virtual Memory Size (VSZ). It includes all memory that the process can access, including memory that is swapped out and memory that is from shared libraries.
  - getResidentSetSize
```
public long getResidentSetSize()
```
    Getter for the field residentSetSize.
    
    Returns:
    
    Returns the Resident Set Size (RSS). On Windows, returns the Private Working Set size. It is used to show how much memory is allocated to that process and is in RAM. It does not include memory that is swapped out. It does include memory from shared libraries as long as the pages from those libraries are actually in memory. It does include all stack and heap memory.
  - getKernelTime
```
public long getKernelTime()
```
    Getter for the field kernelTime.
    
    Returns:
    
    Returns the number of milliseconds the process has executed in kernel/system mode.
  - getUserTime
```
public long getUserTime()
```
    Getter for the field userTime.
    
    Returns:
    
    Returns the number of milliseconds the process has executed in user mode.
  - getUpTime
```
public long getUpTime()
```
    Getter for the field upTime.
    
    Returns:
    
    Returns the number of milliseconds since the process started.
  - getStartTime
```
public long getStartTime()
```
    Getter for the field startTime.
    
    Returns:
    
    Returns the start time of the process in number of milliseconds since January 1, 1970.
  - getBytesRead
```
public long getBytesRead()
```
    Getter for the field bytesRead.
    
    Returns:
    
    Returns the number of bytes the process has read from disk.
  - getBytesWritten
```
public long getBytesWritten()
```
    Getter for the field bytesWritten.
    
    Returns:
    
    Returns the number of bytes the process has written to disk.
  - setName
```
public void setName(String name)
```
    Set the name of the process.
    
    Parameters:
    
    name - process name
  - setPath
```
public void setPath(String path)
```
    Set the full path of the executing process.
    
    Parameters:
    
    path - process path
  - setCommandLine
```
public void setCommandLine(String commandLine)
```
    Sets the process command line.
    
    Parameters:
    
    commandLine - The commandLine to set.
  - setCurrentWorkingDirectory
```
public void setCurrentWorkingDirectory(String currentWorkingDirectory)
```
    Sets the process current working directory
    
    Parameters:
    
    currentWorkingDirectory - The currentWorkingDirectory to set.
  - setUser
```
public void setUser(String user)
```
    Sets the user.
    
    Parameters:
    
    user - The user to set.
  - setUserID
```
public void setUserID(String userID)
```
    Sets the User ID.
    
    Parameters:
    
    userID - The userID to set.
  - setGroup
```
public void setGroup(String group)
```
    Sets the group.
    
    Parameters:
    
    group - The group to set.
  - setGroupID
```
public void setGroupID(String groupID)
```
    Sets the Group ID.
    
    Parameters:
    
    groupID - The groupID to set.
  - setState
```
public void setState(OSProcess.State state)
```
    Set the execution state of the process.
    
    Parameters:
    
    state - execution state
  - setProcessID
```
public void setProcessID(int processID)
```
    Set the processID.
    
    Parameters:
    
    processID - process ID
  - setParentProcessID
```
public void setParentProcessID(int parentProcessID)
```
    Set the parentProcessID.
    
    Parameters:
    
    parentProcessID - parent process ID
  - setThreadCount
```
public void setThreadCount(int threadCount)
```
    Set the number of threads in this process.
    
    Parameters:
    
    threadCount - number of threads
  - setPriority
```
public void setPriority(int priority)
```
    Set the priority of this process. For Linux, priority is a value in the range -20 to 19 (20 on some systems). The default priority is 0; lower priorities cause more favorable scheduling. For Windows, priority values can range from 0 (lowest priority) to 31 (highest priority). Mac OS X has 128 priority levels, ranging from 0 (lowest priority) to 127 (highest priority). They are divided into several major bands: 0 through 51 are the normal levels; the default priority is 31. 52 through 79 are the highest priority regular threads; 80 through 95 are for kernel mode threads; and 96 through 127 correspond to real-time threads, which are treated differently than other threads by the scheduler.
    
    Parameters:
    
    priority - priority
  - setVirtualSize
```
public void setVirtualSize(long virtualSize)
```
    Set the Virtual Memory Size (VSZ). It includes all memory that the process can access, including memory that is swapped out and memory that is from shared libraries.
    
    Parameters:
    
    virtualSize - virtual size
  - setResidentSetSize
```
public void setResidentSetSize(long residentSetSize)
```
    Set the Resident Set Size (RSS). It is used to show how much memory is allocated to that process and is in RAM. It does not include memory that is swapped out. It does include memory from shared libraries as long as the pages from those libraries are actually in memory. It does include all stack and heap memory.
    
    Parameters:
    
    residentSetSize - resident set size
  - setKernelTime
```
public void setKernelTime(long kernelTime)
```
    Set the number of milliseconds the process has executed in kernel mode.
    
    Parameters:
    
    kernelTime - kernel time
  - setUserTime
```
public void setUserTime(long userTime)
```
    Set the number of milliseconds the process has executed in user mode.
    
    Parameters:
    
    userTime - user time
  - setStartTime
```
public void setStartTime(long startTime)
```
    Set the start time of the process in number of milliseconds since January 1, 1970.
    
    Parameters:
    
    startTime - start time
  - setUpTime
```
public void setUpTime(long upTime)
```
    Set the number of milliseconds since the process started.
    
    Parameters:
    
    upTime - up time
  - setBytesRead
```
public void setBytesRead(long bytesRead)
```
    Set the number of bytes the process has read from disk.
    
    Parameters:
    
    bytesRead - number of bytes read
  - setBytesWritten
```
public void setBytesWritten(long bytesWritten)
```
    Set the number of bytes the process has written to disk.
    
    Parameters:
    
    bytesWritten - number of bytes written
  - setOpenFiles
```
public void setOpenFiles(long count)
```
    Sets the number of open file handles (or network connections) that belongs to the process
    
    Parameters:
    
    count - The number of handles
  - getOpenFiles
```
public long getOpenFiles()
```
    Sets the number of open file handles (or network connections) that belongs to the process On FreeBSD and Solaris, this value is only populated if information for a single process id is requested.
    
    Returns:
    
    open files or -1 if unknown or not supported
  - calculateCpuPercent
```
public double calculateCpuPercent()
```
    Calculates CPU usage of this process.
    
    Returns:
    
    The proportion of up time that the process was executing in kernel or user mode.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getBitness
```
public int getBitness()
```
    Attempts to get the bitness (32 or 64) of the process.
    
    Returns:
    
    The bitness, if able to be determined, 0 otherwise.
  - setBitness
```
public void setBitness(int bitness)
```
    Setter for the field bitness.
    
    Parameters:
    
    bitness - The bitness to set.

Class OSProcess

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OSProcess

Method Detail

getName

getPath

getCommandLine

getCurrentWorkingDirectory

getUser

getUserID

getGroup

getGroupID

getState

getProcessID

getParentProcessID

getThreadCount

getPriority

getVirtualSize

getResidentSetSize

getKernelTime

getUserTime

getUpTime

getStartTime

getBytesRead

getBytesWritten

setName

setPath

setCommandLine

setCurrentWorkingDirectory

setUser

setUserID

setGroup

setGroupID

setState

setProcessID

setParentProcessID

setThreadCount

setPriority

setVirtualSize

setResidentSetSize

setKernelTime

setUserTime

setStartTime

setUpTime

setBytesRead

setBytesWritten

setOpenFiles

getOpenFiles

calculateCpuPercent

toString

getBitness

setBitness