dguitar.codecs.guitarPro
Class GPKey

java.lang.Object
  extended bydguitar.codecs.guitarPro.GPKey

public class GPKey
extends java.lang.Object

This class describes the tonality of a measure.

Author:
Matthieu

Field Summary
private static java.lang.String[][] _keyNames
          The keys' names
private static GPKey[][] _keys
          The keys
private  int _mode
          The measure tonality mode: major or minor.
private  int _type
          A measure tonality is represented by an integer.
static GPKey A
          A
static GPKey A_FLAT
          A Flat
static GPKey A_FLAT_MINOR
          A flat minor
static GPKey A_MINOR
          A minor
static GPKey A_SHARP_MINOR
          A sharp minor
static GPKey B
          B
static GPKey B_FLAT
          B Flat
static GPKey B_FLAT_MINOR
          B flat minor
static GPKey B_MINOR
          B minor
static GPKey C
          C
static GPKey C_FLAT
          C Flat
static GPKey C_MINOR
          C minor
static GPKey C_SHARP
          C sharp
static GPKey C_SHARP_MINOR
          C sharp minor
static GPKey D
          D
static GPKey D_FLAT
          D Flat
static GPKey D_MINOR
          D minor
static GPKey D_SHARP_MINOR
          D sharp minor
static GPKey E
          E
static GPKey E_FLAT
          E Flat
static GPKey E_FLAT_MINOR
          E flat minor
static GPKey E_MINOR
          E minor
static GPKey F
          F
static GPKey F_MINOR
          F minor
static GPKey F_SHARP
          F sharp
static GPKey F_SHARP_MINOR
          F sharp minor
static GPKey G
          G
static GPKey G_FLAT
          G Flat
static GPKey G_MINOR
          G minor
static GPKey G_SHARP_MINOR
          G sharp minor
 
Constructor Summary
private GPKey(int mode, int type)
          Creates a new Key whose type is type.
 
Method Summary
 java.lang.String toString()
          Returns a string representation of this Key.
static GPKey valueOf(int type)
          Returns the GPKey associated with the value type.
static GPKey valueOf(int mode, int type)
          Returns the GPKey associated with the values mode and type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_mode

private int _mode
The measure tonality mode: major or minor.


_type

private int _type
A measure tonality is represented by an integer.


C_FLAT

public static final GPKey C_FLAT
C Flat


G_FLAT

public static final GPKey G_FLAT
G Flat


D_FLAT

public static final GPKey D_FLAT
D Flat


A_FLAT

public static final GPKey A_FLAT
A Flat


E_FLAT

public static final GPKey E_FLAT
E Flat


B_FLAT

public static final GPKey B_FLAT
B Flat


F

public static final GPKey F
F


C

public static final GPKey C
C


G

public static final GPKey G
G


D

public static final GPKey D
D


A

public static final GPKey A
A


E

public static final GPKey E
E


B

public static final GPKey B
B


F_SHARP

public static final GPKey F_SHARP
F sharp


C_SHARP

public static final GPKey C_SHARP
C sharp


A_FLAT_MINOR

public static final GPKey A_FLAT_MINOR
A flat minor


E_FLAT_MINOR

public static final GPKey E_FLAT_MINOR
E flat minor


B_FLAT_MINOR

public static final GPKey B_FLAT_MINOR
B flat minor


F_MINOR

public static final GPKey F_MINOR
F minor


C_MINOR

public static final GPKey C_MINOR
C minor


G_MINOR

public static final GPKey G_MINOR
G minor


D_MINOR

public static final GPKey D_MINOR
D minor


A_MINOR

public static final GPKey A_MINOR
A minor


E_MINOR

public static final GPKey E_MINOR
E minor


B_MINOR

public static final GPKey B_MINOR
B minor


F_SHARP_MINOR

public static final GPKey F_SHARP_MINOR
F sharp minor


C_SHARP_MINOR

public static final GPKey C_SHARP_MINOR
C sharp minor


G_SHARP_MINOR

public static final GPKey G_SHARP_MINOR
G sharp minor


D_SHARP_MINOR

public static final GPKey D_SHARP_MINOR
D sharp minor


A_SHARP_MINOR

public static final GPKey A_SHARP_MINOR
A sharp minor


_keys

private static GPKey[][] _keys
The keys


_keyNames

private static java.lang.String[][] _keyNames
The keys' names

Constructor Detail

GPKey

private GPKey(int mode,
              int type)
Creates a new Key whose type is type.

Parameters:
type -
Method Detail

toString

public java.lang.String toString()
Returns a string representation of this Key.


valueOf

public static GPKey valueOf(int type)
Returns the GPKey associated with the value type. (mode = 0).

Parameters:
type - the key's type integer value.
Returns:
the key associated.

valueOf

public static GPKey valueOf(int mode,
                            int type)
Returns the GPKey associated with the values mode and type.

Parameters:
mode - the key's mode integer value.
type - the key's type integer value.
Returns:
the key associated.