# FTVersionImpl

## Abstract

Default implementation for representation of version numbers.

## Methods

`-build`
`+characterForState:`
  determines the representing character for the given state
`+createVersionString`
  creates the version string based on the internal settings
`+createVersionStringForMajor:forMinor:forBuild:forState:`
  creates the version string based on the internal settings
`-description`
`-hash`
`-initWithMajor`
  Initializes with the given version information
`-initWithMajor:withMinor:withBuild:asState:`
  Initializes with the given version information
`-isEqual:`
`-major`
`-minor`
`-releaseState`
`-versionString`
  Used to create a unique string representation of the version.

### build

>     - (unsigned) build;

method result
  build number

### characterForState:

determines the representing character for the given state

>     + (char) characterForState: (ft_releaseState_t) aState;

method result
  representing character for the given state

### createVersionString

creates the version string based on the internal settings

See Also:

> createVersionStringForMajor:forMinor:forBuild:forState:

>     + (NSString *) createVersionStringForMajor: (unsigned) aMajorNr forMinor: (unsigned) aMinorNr forBuild: (unsigned) aBuildNr forState: (ft_releaseState_t) aState;

##### Parameter Descriptions

> `aMajorNr`
>   major number
> `aMinorNr`
>   minor number
> `aBuildNr`
>   build number
> `aState`
>   state of the artefact.

method result
  self

### createVersionStringForMajor:forMinor:forBuild:forState:

creates the version string based on the internal settings

See Also:

> createVersionString

>     + (NSString *) createVersionStringForMajor: (unsigned) aMajorNr forMinor: (unsigned) aMinorNr forBuild: (unsigned) aBuildNr forState: (ft_releaseState_t) aState;

##### Parameter Descriptions

> `aMajorNr`
>   major number
> `aMinorNr`
>   minor number
> `aBuildNr`
>   build number
> `aState`
>   state of the artefact.

### description

>     - (NSString *) description;

method result
  Returns an NSString object that describes the contents of the receiver. The debugger’s print-object command indirectly invokes this method to produce a textual description of an object.

### hash

>     - (unsigned) hash;

method result
  Returns an integer that can be used as a table address in a hash table structure

### initWithMajor

Initializes with the given version information

See Also:

> initWithMajor:withMinor:withBuild:asState:

>     - initWithMajor: (unsigned) aMajorNr withMinor: (unsigned) aMinorNr withBuild: (unsigned) aBuildNr asState: (ft_releaseState_t) aState;

##### Parameter Descriptions

> `aMajorNr`
>   major version number
> `aMinorNr`
>   minor version number
> `aState`
>   state of the build

method result
  self

### initWithMajor:withMinor:withBuild:asState:

Initializes with the given version information

See Also:

> initWithMajor

>     - initWithMajor: (unsigned) aMajorNr withMinor: (unsigned) aMinorNr withBuild: (unsigned) aBuildNr asState: (ft_releaseState_t) aState;

##### Parameter Descriptions

> `aMajorNr`
>   major version number
> `aMinorNr`
>   minor version number
> `aState`
>   state of the build

### isEqual:

>     - (BOOL) isEqual: (id) anObject;

method result
  Returns YES if the receiver and anObject are equal, NO otherwise.

### major

>     - (unsigned) major;

method result
  major version number

### minor

>     - (unsigned) minor;

method result
  returns minor version number

### releaseState

>     - (ft_releaseState_t) releaseState;

method result
  state of the release

### versionString

Used to create a unique string representation of the version.

>     - (NSString *) versionString;

method result
  string representation of the version

(Last Updated August 27, 2006)