Package ghidra.framework.store
Class ItemCheckoutStatus
- java.lang.Object
-
- ghidra.framework.store.ItemCheckoutStatus
-
- All Implemented Interfaces:
java.io.Serializable
public class ItemCheckoutStatus extends java.lang.Object implements java.io.Serializable
ItemCheckoutStatus
provides immutable status information for a checked-out item. This class is serializable so that it may be passed to a remote client.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description ItemCheckoutStatus(long checkoutId, CheckoutType checkoutType, java.lang.String user, int version, long time, java.lang.String projectPath)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.util.Date
getCheckoutDate()
Returns the time at which the checkout was completed.long
getCheckoutId()
Returns the unique ID for the associated checkout.long
getCheckoutTime()
Returns the time at which the checkout was completed.CheckoutType
getCheckoutType()
Returns the checkout typeint
getCheckoutVersion()
Returns the file version which was checked-out.java.lang.String
getProjectLocation()
Return a Project location which corresponds to the projectPath or null if one can not be constructed.java.lang.String
getProjectName()
Return a Project location which corresponds to the projectPath or null if one can not be constructed.java.lang.String
getProjectPath()
Returns user's local project path if known.static java.lang.String
getProjectPath(java.lang.String projectPath, boolean isTransient)
Get project path string suitable for checkout requestsjava.lang.String
getUser()
Returns the user name for the associated checkout.java.lang.String
getUserHostName()
Returns the user's hostname associated with the original checkoutint
hashCode()
-
-
-
Field Detail
-
serialVersionUID
public static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ItemCheckoutStatus
public ItemCheckoutStatus(long checkoutId, CheckoutType checkoutType, java.lang.String user, int version, long time, java.lang.String projectPath)
Constructor.- Parameters:
checkoutId
- unique checkout IDcheckoutType
- type of checkoutuser
- user nameversion
- version of file which was checked-outtime
- time when checkout was completed.
-
-
Method Detail
-
getCheckoutId
public long getCheckoutId()
Returns the unique ID for the associated checkout.
-
getCheckoutType
public CheckoutType getCheckoutType()
Returns the checkout type- Returns:
- checkout type
-
getUser
public java.lang.String getUser()
Returns the user name for the associated checkout.
-
getCheckoutVersion
public int getCheckoutVersion()
Returns the file version which was checked-out.
-
getCheckoutTime
public long getCheckoutTime()
Returns the time at which the checkout was completed.
-
getCheckoutDate
public java.util.Date getCheckoutDate()
Returns the time at which the checkout was completed.- Returns:
-
getProjectPath
public java.lang.String getProjectPath()
Returns user's local project path if known.
-
getProjectName
public java.lang.String getProjectName()
Return a Project location which corresponds to the projectPath or null if one can not be constructed.- Returns:
- project location
-
getProjectLocation
public java.lang.String getProjectLocation()
Return a Project location which corresponds to the projectPath or null if one can not be constructed.- Returns:
- project location
-
getUserHostName
public java.lang.String getUserHostName()
Returns the user's hostname associated with the original checkout- Returns:
- host name or null
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
getProjectPath
public static java.lang.String getProjectPath(java.lang.String projectPath, boolean isTransient)
Get project path string suitable for checkout requests- Parameters:
projectPath
-isTransient
- true if project is transient- Returns:
- project location path
-
-