org.eclipse.jgit.transport
Class CredentialItem.CharArrayType

java.lang.Object
  extended by org.eclipse.jgit.transport.CredentialItem
      extended by org.eclipse.jgit.transport.CredentialItem.CharArrayType
Direct Known Subclasses:
CredentialItem.Password
Enclosing class:
CredentialItem

public static class CredentialItem.CharArrayType
extends CredentialItem

An item whose value is stored as a char[] and is therefore clearable.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.jgit.transport.CredentialItem
CredentialItem.CharArrayType, CredentialItem.InformationalMessage, CredentialItem.Password, CredentialItem.StringType, CredentialItem.Username, CredentialItem.YesNoType
 
Constructor Summary
CredentialItem.CharArrayType(String promptText, boolean maskValue)
          Initialize a prompt for a secure value stored in a character array.
 
Method Summary
 void clear()
          Destroys the current value, clearing the internal array.
 char[] getValue()
          Get the current value.
 void setValue(char[] newValue)
          Set the new value, clearing the old value array.
 void setValueNoCopy(char[] newValue)
          Set the new value, clearing the old value array.
 
Methods inherited from class org.eclipse.jgit.transport.CredentialItem
getPromptText, isValueSecure
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CredentialItem.CharArrayType

public CredentialItem.CharArrayType(String promptText,
                                    boolean maskValue)
Initialize a prompt for a secure value stored in a character array.

Parameters:
promptText - prompt to display to the user alongside of the input field. Should be sufficient text to indicate what to supply for this item.
maskValue - true if the value should be masked from displaying during input. This should be true for passwords and other secrets, false for names and other public data.
Method Detail

clear

public void clear()
Destroys the current value, clearing the internal array.

Specified by:
clear in class CredentialItem

getValue

public char[] getValue()
Get the current value. The returned array will be cleared out when clear() is called. Callers that need the array elements to survive should delay invoking clear() until the value is no longer necessary.

Returns:
the current value array. The actual internal array is returned, reducing the number of copies present in memory.

setValue

public void setValue(char[] newValue)
Set the new value, clearing the old value array.

Parameters:
newValue - if not null, the array is copied.

setValueNoCopy

public void setValueNoCopy(char[] newValue)
Set the new value, clearing the old value array.

Parameters:
newValue - the new internal array. The array is NOT copied.


Copyright © 2012. All Rights Reserved.