# Interface: com.pnfsoftware.jeb.core.units.code.asm.processor.IRegisterBank

A layout definition for a bank of registers.  

  Bank layout for common processors are defined in the `arch` sub\-package.

## Abstract Method: format
- parameter: `type`, type: `int`
- return type: `java.lang.String`

Description: Format the register bank as a string.
parameter: type: 0: short\-form \(i.e., `toString()`\), 1: user\-friendly long\-form
return: the formatted bank

## Abstract Method: getAllDescriptionEntries
- return type: `java.util.Collection<com.pnfsoftware.jeb.core.units.code.asm.processor.RegisterDescriptionEntry>`

Description: Get the list of all \(full and slices\) register entries.
return: full and slice register entries

## Abstract Method: getCountOfDescriptionEntries
- return type: `int`

Description: Get the number of full register entries. Slices are not counted.
return: number of full register entries

## Abstract Method: getDescriptionEntries
- return type: `java.util.Collection<com.pnfsoftware.jeb.core.units.code.asm.processor.RegisterDescriptionEntry>`

Description: Get the list of full register entries. Slices are not returned.
return: full register entries

## Abstract Method: getDescriptionEntry
- parameter: `regnum`, type: `int`
- return type: `com.pnfsoftware.jeb.core.units.code.asm.processor.RegisterDescriptionEntry`

Description: Get a full register entry by index \(do not confuse with id\). Slices cannot be retrieved.
parameter: regnum: register index
return: register entry, or null

## Abstract Method: getDescriptionEntryById
- parameter: `id`, type: `long`
- return type: `com.pnfsoftware.jeb.core.units.code.asm.processor.RegisterDescriptionEntry`

Description: Get a register entry \(full or slice\) by id \(do not confuse with index\).
parameter: id: register id
return: register entry, or null

## Abstract Method: getDescriptionEntryByName
- parameter: `name`, type: `java.lang.String`
- return type: `com.pnfsoftware.jeb.core.units.code.asm.processor.RegisterDescriptionEntry`

Description: Get a register entry \(full or slice\) by name.
parameter: name: register name
return: register entry, or null

## Abstract Method: getDescriptionEntryByName
- parameter: `names`, type: `java.util.Collection<java.lang.String>`
- return type: `com.pnfsoftware.jeb.core.units.code.asm.processor.RegisterDescriptionEntry`

Description: Get a register entry \(full or slice\) by name, using a list of candidate names. Useful when a  register goes by different names.
parameter: names: candidate names
return: register entry, or null

## Abstract Method: getDescriptionEntryByType
- parameter: `type`, type: `com.pnfsoftware.jeb.core.units.code.asm.processor.RegisterType`
- return type: `com.pnfsoftware.jeb.core.units.code.asm.processor.RegisterDescriptionEntry`

Description: Get a full register entry by type. Slices cannot be retrieved.
parameter: type: register type
return: register entry, or null