ChoiceOfTime (6.0 API Documentation)

java.lang.Object
- iaik.asn1.structures.ChoiceOfTime

```
public class ChoiceOfTime
extends java.lang.Object
```
This class represents the ASN.1 structure "ChoiceOfTime".
```
 ChoiceOfTime ::= CHOICE {
       utcTime        UTCTime,
       generalTime    GeneralizedTime }
 
```
This class handles both possible rules to encode a date. The encoding format should depend on the following rule:
Till year 2050 the date shall be encoded as UTCTime. After 2050 the date shall be encoded as GeneralizedTime.
- UTCTime UTCTime values are expressed as Greenwich Mean Time (Zulu) and include seconds (i.e., times are YYMMDDHHMMSSZ), even where the number of seconds is zero. Conforming systems shall interpret the year field (YY) as follows:
  - Where YY is greater than 50, the year shall be interpreted as 19YY; and
  - Where YY is less than or equal to 50, the year shall be interpreted as 20YY.
- GeneralizedTime GeneralizedTime values are expressed as Greenwich Mean Time (Zulu) and include seconds (i.e.,times are YYYYMMDDHHMMSSZ), even where the number of seconds is zero.GeneralizedTime values shall not include fractional seconds.
Per default the encoding scheme of this class is set to UTCTime meaning that per default the date value of a ChoiceOfTime object will be encoded as UTCTime. However, an application may call the setEncodingType method for enforcing a GeneralizedTime encoding, e.g.:
```
 ChoiceOfTime choiceOfTime = new ChoiceOfTime();
 choiceOfTime.setEncodingType(ASN.GeneralizedTime);
 
```
This class supplies four constructors for specifying the Date to be represented by a ChoiceOfTime object:
- The standard constructor creates a ChoiceOfTime object for the current date:
```
 ChoiceOfTime choiceOfTime = new ChoiceOfTime();
 
```
- A constructor that expects the Date specification as java.util.Date instance, e.g.:
```
     Date date = ...;
     ChoiceOfTime choiceOfTime = new ChoiceOfTime(date);
 
```
- A constructor that contains a boolean parameter do2050Encoding that can be set to automatically encode time values before 2050 as UTCTime and after 2050 as GeneralizedTime , e.g.:
```
     Date date = ...;
     ChoiceOfTime choiceOfTime = new ChoiceOfTime(date, true);
 
```
- A constructor where the Date may be supplied as string representation of format "yyyyMMDDHHmmss" (year MonthOfYear DayOfMonth HourOfDay minuteOfHour secondOfMinute) and an optional local time-shift against Coordinated Universal Time (UTC time), which may be indicated by a plus (+) or minus (-) sign, followed by hour and minute specifications, each of them owning two digits, e.g:
```
 String timeStr = "19991003121730+0230";
 ChoiceOfTime choiceOfTime = new ChoiceOfTime("19991003121730+0230",
     ASN.GeneralizedTime);
 
```
  The second argument above enforces that the Date has to be encoded as GeneralizedTime instead of UTCTime.
Version:

File Revision 21

See Also:
UTCTime, GeneralizedTime

Constructor Summary

Constructors
Constructor and Description
`ChoiceOfTime()` Creates a new ChoiceOfTime from the current Date.
`ChoiceOfTime(ASN1Object obj)` Creates a new ChoiceOfTime from an ASN1Object.
`ChoiceOfTime(java.util.Date date)` Creates a new ChoiceOfTime from the given Date.
`ChoiceOfTime(java.util.Date date, ASN encodingType)` Creates a new ChoiceOfTime from the given Date using the specified encoding type.
`ChoiceOfTime(java.util.Date date, ASN encodingType, boolean includeMilliSeconds)` Creates a new ChoiceOfTime from the given Date using the specified encoding type.
`ChoiceOfTime(java.util.Date date, boolean do2050Encoding)` Creates a new ChoiceOfTime from the given Date.
`ChoiceOfTime(java.util.Date date, boolean do2050Encoding, boolean includeMilliSeconds)` Creates a new ChoiceOfTime from the given Date.
`ChoiceOfTime(java.lang.String date, ASN encodingType)` Creates a ChoiceOfTime for the given date, represented as string.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Compares this ChoiceOfTime with the given object.
`java.util.Date`	`getDate()` Returns the date this ChoiceOfTime represents.
`ASN`	`getEncodingType()` Returns the encoding type, either UTCTime or GeneralizedTime.
`int`	`hashCode()` Returns a hash code for this object.
`void`	`setEncodingType(ASN encodingType)` Sets the encoding type.
`ASN1Object`	`toASN1Object()` Returns the value of this object as an ASN1Object.
`java.lang.String`	`toString()` Returns a string that represents the contents of the extensions.

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

- Constructor Detail
  - ChoiceOfTime
```
public ChoiceOfTime()
```
    Creates a new ChoiceOfTime from the current Date.
    Per default the encoding scheme is set to UTCTime. Use the setEncodingType method for enforcing a GeneralizedTime encoding.
  - ChoiceOfTime
```
public ChoiceOfTime(java.util.Date date)
```
    Creates a new ChoiceOfTime from the given Date.
    Per default the encoding scheme is set to UTCTime. Use the ChoiceOfTime(date, encodingType) constructor for enforcing a GeneralizedTime encoding.
    
    Parameters:
    date - the desired date
  - ChoiceOfTime
```
public ChoiceOfTime(java.util.Date date,
            boolean do2050Encoding)
```
    Creates a new ChoiceOfTime from the given Date.
    Per default the encoding scheme is set to UTCTime.
    If do2050Encoding is set to true automatically time values before 2050 are encoded as UTCTime and after 2050 as GeneralizedTime, e.g.:
```
 Date date = ...;
 ChoiceOfTime choiceOfTime = new ChoiceOfTime(date, true);
 
```
    Milliseconds are included in GeneralizedTime encodings.
    Parameters:
    date - the desired date
    do2050Encoding - whether to automatically switch to GeneralizedTime for dates beyound 2050
  - ChoiceOfTime
```
public ChoiceOfTime(java.util.Date date,
            boolean do2050Encoding,
            boolean includeMilliSeconds)
```
    Creates a new ChoiceOfTime from the given Date.
    Per default the encoding scheme is set to UTCTime. Use the setEncodingType method for enforcing a GeneralizedTime encoding.
    If do2050Encoding is set to true automatically time values before 2050 are encoded as UTCTime and after 2050 as GeneralizedTime, e.g.:
```
 Date date = ...;
 ChoiceOfTime choiceOfTime = new ChoiceOfTime(date, true);
 
```
    Parameters:
    date - the desired date
    do2050Encoding - whether to automatically switch to GeneralizedTime for dates beyound 2050
    includeMilliSeconds - whether to include milliseconds in GeneralizedTime encoding. Some profiles, e.g. PKIX, may require to not include fractional seconds if GeneralizedTime is used). Default is true (milliseconds are included). If set false milliseconds are stripped.
  - ChoiceOfTime
```
public ChoiceOfTime(java.util.Date date,
            ASN encodingType)
```
    Creates a new ChoiceOfTime from the given Date using the specified encoding type. If GeneralizedTime is used, milliseconds are included in the encoding.
    
    Parameters:
    date - the desired date
    encodingType - the encoding type, either UTCTime or GeneralizedTime
    
    Throws:
    
    java.lang.IllegalArgumentException - if the supplied encoding type is not UTCTime or GeneralizedTime
  - ChoiceOfTime
```
public ChoiceOfTime(java.util.Date date,
            ASN encodingType,
            boolean includeMilliSeconds)
```
    Creates a new ChoiceOfTime from the given Date using the specified encoding type.
    
    Parameters:
    date - the desired date
    encodingType - the encoding type, either UTCTime or GeneralizedTime
    includeMilliSeconds - whether to include milliseconds in GeneralizedTime encoding. Some profiles, e.g. PKIX, may require to not include fractional seconds if GeneralizedTime is used). Default is true (milliseconds are included). If set false milliseconds are stripped.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the supplied encoding type is not UTCTime or GeneralizedTime
  - ChoiceOfTime
```
public ChoiceOfTime(java.lang.String date,
            ASN encodingType)
             throws java.text.ParseException
```
    Creates a ChoiceOfTime for the given date, represented as string. The string representation has to fulfill the format "yyyyMMDDHHmmss" (year MonthOfYear DayOfMonth HourOfDay minuteOfHour secondOfMinute) and an optional local time-shift against Coordinated Universal Time (UTC time), which may be indicated by a plus (+) or minus (-) sign, followed by hour and minute specifications, each of them owning two digits, e.g:
```
 String timeStr = "19991003121730+0230";
 ChoiceOfTime choiceOfTime = new ChoiceOfTime("19991003121730+0230",
     ASN.GeneralizedTime);
 
```
    The second argument above enforces that the Date has to be encoded as GeneralizedTime instead of UTCTime.
    Parameters:
    date - the string containing the date
    encodingType - the encoding type, either UTCTime or GeneralizedTime
    
    Throws:
    
    java.text.ParseException - if the format of the date is not correct
    
    java.lang.IllegalArgumentException - if the supplied encoding type is not UTCTime or GeneralizedTime
  - ChoiceOfTime
```
public ChoiceOfTime(ASN1Object obj)
             throws CodingException
```
    Creates a new ChoiceOfTime from an ASN1Object. The supplied ASN1Object represents an already existing ChoiceOfTime that may have been created by means of the toASN1Object() method.
    
    Parameters:
    obj - the ChoiceOfTime as ASN1Object
    
    Throws:
    
    CodingException - if the ASN1Object could not be parsed
- Method Detail
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Returns the value of this object as an ASN1Object. The type of the ASN1Object returned by this method is either UTCTime or GeneralizedTime.
    
    Returns:
    the value of this object as an ASN1Object
  - getEncodingType
```
public ASN getEncodingType()
```
    Returns the encoding type, either UTCTime or GeneralizedTime.
    
    Returns:
    the encoding type
  - setEncodingType
```
public void setEncodingType(ASN encodingType)
                     throws java.lang.IllegalArgumentException
```
    Sets the encoding type.
    Please note that when you have created a ChoiceOfTime of type UTCTime and now change to GeneralizedTime, the millisecond value may be zero; so it might be perferable to set the encoding type right from the beginning when creating a ChoiceOfTime object.
    
    Parameters:
    encodingType - the encoding type
    
    Throws:
    
    java.lang.IllegalArgumentException - if the supplied encoding type is not UTCTime or GeneralizedTime
  - getDate
```
public java.util.Date getDate()
```
    Returns the date this ChoiceOfTime represents.
    
    Returns:
    the date
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    a hash code for this object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares this ChoiceOfTime with the given object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    obj - the object to compare with
    
    Returns:
    true if the two objects are equal (represent the same ASN.1 time type and the same time value, false if they are not equal
  - toString
```
public java.lang.String toString()
```
    Returns a string that represents the contents of the extensions.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the string representation

Class ChoiceOfTime

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChoiceOfTime

ChoiceOfTime

ChoiceOfTime

ChoiceOfTime

ChoiceOfTime

ChoiceOfTime

ChoiceOfTime

ChoiceOfTime

Method Detail

toASN1Object

getEncodingType

setEncodingType

getDate

hashCode

equals

toString