enigma.machine

Class Rotor

java.lang.Object

enigma.machine.Rotor

public class Rotor
extends java.lang.Object

A Rotor represents a physical rotor in an Enigma Machine
It starts out with an initial position and moves using the methods provided
A rotor's physical structure can bet set using the constructor but they cannot be changed later (except the position)

Constructor Summary

Constructors

Constructor and Description
Rotor() Create a Rotor with default settings starting at position 1
Rotor(int pos) Create a Rotor with default settings starting at position pos
Rotor(int pos, Rotor connection) Creates a Rotor with default settings starting at position pos with a connection to another Rotor When the rotor completes a full turn (as specified by fullTurn) it turns the connection

Method Summary

Modifier and Type	Method and Description
static Rotor	createRotor(java.lang.String rotorName, Rotor connection) Creates a Rotor with the specified settings
static Rotor	createRotor(java.lang.String from, java.lang.String to, Rotor connection, int[] fullTurn) Creates a Rotor with the specified settings
Rotor	getConnection()
int	getCurrentPos()
java.lang.String	getName()
void	rotate() Rotates the rotor and if it rotates a full turn, rotates the next one
void	setConnection(Rotor connection)
void	setCurrentPos(char currPos) Set the current position of the rotor.
void	setCurrentPos(int currPos) Set the current position of the rotor
void	setName(java.lang.String name)
java.lang.String	toString()
char	translateLeftToRight(char input) Translates a character to another (based on the wiring of the rotor) This simulates a signal coming from the right side of the rotor and exiting from the left side
char[]	translateLeftToRightSteps(char input) Translates a character to another (based on the wiring of the rotor) This simulates a signal coming from the right side of the rotor and exiting from the left side
char	translateRightToLeft(char input) Translates a character to another (based on the wiring of the rotor) This simulates a signal coming from the left side of the rotor and exiting from the right side
char[]	translateRightToLeftSteps(char input) Translates a character to another (based on the wiring of the rotor) This simulates a signal coming from the left side of the rotor and exiting from the right side

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Rotor

public Rotor()

Create a Rotor with default settings starting at position 1

Rotor

public Rotor(int pos)

Create a Rotor with default settings starting at position pos

Parameters:

pos - has to be an int between 1 and 26 (inclusive)

Rotor

public Rotor(int pos,
             Rotor connection)

Creates a Rotor with default settings starting at position pos with a connection to another Rotor When the rotor completes a full turn (as specified by fullTurn) it turns the connection

Parameters:

pos - has to be an int between 1 and 26 (inclusive)

connection - another rotor

Method Detail

createRotor

public static Rotor createRotor(java.lang.String from,
                                java.lang.String to,
                                Rotor connection,
                                int[] fullTurn)

Creates a Rotor with the specified settings

Parameters:

from - from and to specify the wiring. from[i] -> to[i]

to - both from and to must have length == 26 and both of them must contain all the alphabet in UPPERCASE

connection - a connection to another rotor. When this rotor completes a full turn it turns the connection. Can be null

fullTurn - Where is the full turn. If fullTurn is null, it sets it to the default value of rotor "I"

Returns:

a new Rotor or null if there is an error

createRotor

public static Rotor createRotor(java.lang.String rotorName,
                                Rotor connection)

Creates a Rotor with the specified settings

Parameters:

rotorName - the name of a default rotor, acceptable names are (source)

• I
• II
• III
• IV
• V
• VI
• VII
• VIII

connection - a connection to another rotor. When this rotor completes a full turn it turns connection. Can be null

Returns:

a new Rotor or null if there is an error

getCurrentPos

public int getCurrentPos()

Returns:

the current position of the rotor

setCurrentPos

public void setCurrentPos(int currPos)

Set the current position of the rotor

Parameters:

currPos - has to be an int between 1 and 26 (inclusive)

setCurrentPos

public void setCurrentPos(char currPos)

Set the current position of the rotor. 'A' corresponds to 1

Parameters:

currPos - current position as a letter. currPos must be a letter

getConnection

public Rotor getConnection()

Returns:

the connection (to another Rotor)

setConnection

public void setConnection(Rotor connection)

Parameters:

connection - set the connection (to another Rotor)

rotate

public void rotate()

Rotates the rotor and if it rotates a full turn, rotates the next one

translateRightToLeft

public char translateRightToLeft(char input)

Translates a character to another (based on the wiring of the rotor) This simulates a signal coming from the left side of the rotor and exiting from the right side

Parameters:

input - the character to translate

Returns:

the translated to a character

translateLeftToRight

public char translateLeftToRight(char input)

Translates a character to another (based on the wiring of the rotor) This simulates a signal coming from the right side of the rotor and exiting from the left side

Parameters:

input - the character to translate

Returns:

the translated to a character

translateRightToLeftSteps

public char[] translateRightToLeftSteps(char input)

Translates a character to another (based on the wiring of the rotor) This simulates a signal coming from the left side of the rotor and exiting from the right side

Parameters:

input - the character to translate

Returns:

all the steps of translation. The result can be found at char[lengh - 1] == char[4]

Format of result: input after filtration, input after shift, input after map, input after shift, output

translateLeftToRightSteps

public char[] translateLeftToRightSteps(char input)

Translates a character to another (based on the wiring of the rotor) This simulates a signal coming from the right side of the rotor and exiting from the left side

Parameters:

input - the character to translate

Returns:

all the steps of translation. The result can be found at char[lengh - 1] == char[4]

Format of result: input after filtration, input after shift, input after map, input after shift, output

getName

public java.lang.String getName()

Returns:

the name

setName

public void setName(java.lang.String name)

Parameters:

name - the name to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()