forestry.core.genetics.alleles

Class AlleleRegistry

java.lang.Object

forestry.core.genetics.alleles.AlleleRegistry

All Implemented Interfaces:

IAlleleRegistry

public class AlleleRegistry
extends java.lang.Object
implements IAlleleRegistry

Constructor Summary

Constructors

Constructor and Description
AlleleRegistry()

Method Summary

Modifier and Type	Method and Description
void	addValidAlleleTypes(IAllele allele, IChromosomeType... chromosomeTypes) Add more valid chromosome types for an allele.
void	blacklistAllele(java.lang.String uid) Blacklist an allele identified by its UID from mutation.
IClassification	createAndRegisterClassification(IClassification.EnumClassLevel level, java.lang.String uid, java.lang.String scientific) Creates and returns a classification.
IClassification	createAndRegisterClassification(IClassification.EnumClassLevel level, java.lang.String uid, java.lang.String scientific, IClassification... members)
IAllele	getAllele(java.lang.String uid) Gets an allele
java.util.Collection<java.lang.String>	getAlleleBlacklist()
java.util.Collection<IChromosomeType>	getChromosomeTypes(IAllele allele)
IClassification	getClassification(java.lang.String uid) Gets a classification.
java.util.Map<java.lang.String,IAllele>	getDeprecatedAlleleReplacements()
IFruitFamily	getFruitFamily(java.lang.String uid) Retrieves a fruit family identified by uid.
IIndividual	getIndividual(net.minecraft.item.ItemStack stack) Retrieve genetic information from an itemstack.
net.minecraft.item.ItemStack	getMutationNoteStack(com.mojang.authlib.GameProfile researcher, IMutation mutation)
java.util.Map<java.lang.String,IAllele>	getRegisteredAlleles()
java.util.Collection<IAllele>	getRegisteredAlleles(IChromosomeType type)
java.util.Map<java.lang.String,IClassification>	getRegisteredClassifications()
java.util.Map<java.lang.String,IFruitFamily>	getRegisteredFruitFamilies() Get all registered fruit families.
net.minecraft.item.ItemStack	getSpeciesNoteStack(com.mojang.authlib.GameProfile researcher, IAlleleSpecies species)
java.util.Map<java.lang.String,ISpeciesRoot>	getSpeciesRoot()
ISpeciesRoot	getSpeciesRoot(java.lang.Class<? extends IIndividual> individualClass) Retrieve a matching ISpeciesRoot for the given IIndividual-class.
ISpeciesRoot	getSpeciesRoot(IIndividual individual) Retrieve a matching ISpeciesRoot for the given IIndividual
ISpeciesRoot	getSpeciesRoot(net.minecraft.item.ItemStack stack) Retrieve a matching ISpeciesRoot for the given itemstack.
ISpeciesRoot	getSpeciesRoot(java.lang.String uid) Retrieve the ISpeciesRoot with the given uid.
void	initialize()
boolean	isBlacklisted(java.lang.String uid)
boolean	isIndividual(net.minecraft.item.ItemStack stack) Tests the itemstack for genetic information.
void	registerAllele(IAllele allele, IChromosomeType... chromosomeTypes) Registers an allele.
void	registerAlleleHandler(IAlleleHandler handler) Registers a new IAlleleHandler
void	registerClassification(IClassification branch) Registers a classification.
void	registerDeprecatedAlleleReplacement(java.lang.String deprecatedUID, IAllele replacementAllele) Registers an old allele UID and the new IAllele to replace instances of it with.
void	registerFruitFamily(IFruitFamily family) Registers a new fruit family.
void	registerSpeciesRoot(ISpeciesRoot root) Register a ISpeciesRoot.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlleleRegistry

public AlleleRegistry()

Method Detail

registerSpeciesRoot

public void registerSpeciesRoot(ISpeciesRoot root)

Description copied from interface: IAlleleRegistry

Register a ISpeciesRoot.

Specified by:

registerSpeciesRoot in interface IAlleleRegistry

Parameters:

root - ISpeciesRoot to register.

getSpeciesRoot

public java.util.Map<java.lang.String,ISpeciesRoot> getSpeciesRoot()

Specified by:

getSpeciesRoot in interface IAlleleRegistry

Returns:

Map of all registered ISpeciesRoot.

getSpeciesRoot

@Nullable
public ISpeciesRoot getSpeciesRoot(java.lang.String uid)

Description copied from interface: IAlleleRegistry

Retrieve the ISpeciesRoot with the given uid.

Specified by:

getSpeciesRoot in interface IAlleleRegistry

Parameters:

uid - Unique id for the species class, i.e. "rootBees", "rootTrees", "rootButterflies".

Returns:

ISpeciesRoot if it exists, null otherwise.

getSpeciesRoot

@Nullable
public ISpeciesRoot getSpeciesRoot(net.minecraft.item.ItemStack stack)

Description copied from interface: IAlleleRegistry

Retrieve a matching ISpeciesRoot for the given itemstack.

Specified by:

getSpeciesRoot in interface IAlleleRegistry

Parameters:

stack - An itemstack possibly containing NBT data which can be converted by a species root.

Returns:

ISpeciesRoot if found, null otherwise.

getSpeciesRoot

@Nullable
public ISpeciesRoot getSpeciesRoot(java.lang.Class<? extends IIndividual> individualClass)

Description copied from interface: IAlleleRegistry

Retrieve a matching ISpeciesRoot for the given IIndividual-class.

Specified by:

getSpeciesRoot in interface IAlleleRegistry

Parameters:

individualClass - Class extending IIndividual.

Returns:

ISpeciesRoot if found, null otherwise.

getSpeciesRoot

public ISpeciesRoot getSpeciesRoot(IIndividual individual)

Description copied from interface: IAlleleRegistry

Retrieve a matching ISpeciesRoot for the given IIndividual

Specified by:

getSpeciesRoot in interface IAlleleRegistry

isIndividual

public boolean isIndividual(net.minecraft.item.ItemStack stack)

Description copied from interface: IAlleleRegistry

Tests the itemstack for genetic information.

Specified by:

isIndividual in interface IAlleleRegistry

Returns:

true if the itemstack is an individual.

getIndividual

@Nullable
public IIndividual getIndividual(net.minecraft.item.ItemStack stack)

Description copied from interface: IAlleleRegistry

Retrieve genetic information from an itemstack.

Specified by:

getIndividual in interface IAlleleRegistry

Parameters:

stack - Stack to retrieve genetic information for.

Returns:

IIndividual containing genetic information, null if none could be extracted.

initialize

public void initialize()

getRegisteredAlleles

public java.util.Map<java.lang.String,IAllele> getRegisteredAlleles()

Specified by:

getRegisteredAlleles in interface IAlleleRegistry

Returns:

HashMap of all currently registered alleles.

getDeprecatedAlleleReplacements

public java.util.Map<java.lang.String,IAllele> getDeprecatedAlleleReplacements()

Specified by:

getDeprecatedAlleleReplacements in interface IAlleleRegistry

Returns:

HashMap of all registered deprecated alleles and their corresponding replacements

registerAllele

public void registerAllele(IAllele allele,
                           IChromosomeType... chromosomeTypes)

Description copied from interface: IAlleleRegistry

Registers an allele.

NOTE: Where possible, it is recommended to use IAlleleFactory instead because it has built-in advanced localization support.

Specified by:

registerAllele in interface IAlleleRegistry

Parameters:

allele - IAllele to register.

chromosomeTypes - valid chromosomeTypes for this allele.

addValidAlleleTypes

public void addValidAlleleTypes(IAllele allele,
                                IChromosomeType... chromosomeTypes)

Description copied from interface: IAlleleRegistry

Add more valid chromosome types for an allele. Used by addons that create new chromosome types beyond bees, trees, and butterflies.

Specified by:

addValidAlleleTypes in interface IAlleleRegistry

registerDeprecatedAlleleReplacement

public void registerDeprecatedAlleleReplacement(java.lang.String deprecatedUID,
                                                IAllele replacementAllele)

Description copied from interface: IAlleleRegistry

Registers an old allele UID and the new IAllele to replace instances of it with.

Specified by:

registerDeprecatedAlleleReplacement in interface IAlleleRegistry

Parameters:

deprecatedUID - the old allele's UID

replacementAllele - the IAllele that the deprecated Allele will be replaced with.

getAllele

@Nullable
public IAllele getAllele(java.lang.String uid)

Description copied from interface: IAlleleRegistry

Gets an allele

Specified by:

getAllele in interface IAlleleRegistry

Parameters:

uid - String based unique identifier of the allele to retrieve.

Returns:

IAllele if found or a replacement is found in the Deprecated Allele map, null otherwise.

getRegisteredAlleles

public java.util.Collection<IAllele> getRegisteredAlleles(IChromosomeType type)

Specified by:

getRegisteredAlleles in interface IAlleleRegistry

Returns:

unmodifiable collection of all the known allele variations for the given chromosome type.

getChromosomeTypes

public java.util.Collection<IChromosomeType> getChromosomeTypes(IAllele allele)

Specified by:

getChromosomeTypes in interface IAlleleRegistry

Returns:

unmodifiable collection of all the known chromosome types.

registerClassification

public void registerClassification(IClassification branch)

Description copied from interface: IAlleleRegistry

Registers a classification.

Specified by:

registerClassification in interface IAlleleRegistry

Parameters:

branch - IClassification to register.

getRegisteredClassifications

public java.util.Map<java.lang.String,IClassification> getRegisteredClassifications()

Specified by:

getRegisteredClassifications in interface IAlleleRegistry

Returns:

HashMap of all currently registered classifications.

createAndRegisterClassification

public IClassification createAndRegisterClassification(IClassification.EnumClassLevel level,
                                                       java.lang.String uid,
                                                       java.lang.String scientific)

Description copied from interface: IAlleleRegistry

Creates and returns a classification.

Specified by:

createAndRegisterClassification in interface IAlleleRegistry

Parameters:

level - EnumClassLevel of the classification to create.

uid - String based unique identifier. Implementation will throw an exception if the key is already taken.

scientific - Binomial for the given classification.

Returns:

Created IClassification for easier chaining.

createAndRegisterClassification

public IClassification createAndRegisterClassification(IClassification.EnumClassLevel level,
                                                       java.lang.String uid,
                                                       java.lang.String scientific,
                                                       IClassification... members)

Specified by:

createAndRegisterClassification in interface IAlleleRegistry

getClassification

public IClassification getClassification(java.lang.String uid)

Description copied from interface: IAlleleRegistry

Gets a classification.

Specified by:

getClassification in interface IAlleleRegistry

Parameters:

uid - String based unique identifier of the classification to retrieve.

Returns:

IClassification if found, null otherwise.

registerFruitFamily

public void registerFruitFamily(IFruitFamily family)

Description copied from interface: IAlleleRegistry

Registers a new fruit family.

Specified by:

registerFruitFamily in interface IAlleleRegistry

getRegisteredFruitFamilies

public java.util.Map<java.lang.String,IFruitFamily> getRegisteredFruitFamilies()

Description copied from interface: IAlleleRegistry

Get all registered fruit families.

Specified by:

getRegisteredFruitFamilies in interface IAlleleRegistry

Returns:

A map of registered fruit families and their UIDs.

getFruitFamily

public IFruitFamily getFruitFamily(java.lang.String uid)

Description copied from interface: IAlleleRegistry

Retrieves a fruit family identified by uid.

Specified by:

getFruitFamily in interface IAlleleRegistry

Returns:

{IFruitFamily} if found, false otherwise.

registerAlleleHandler

public void registerAlleleHandler(IAlleleHandler handler)

Description copied from interface: IAlleleRegistry

Registers a new IAlleleHandler

Specified by:

registerAlleleHandler in interface IAlleleRegistry

Parameters:

handler - IAlleleHandler to register.

blacklistAllele

public void blacklistAllele(java.lang.String uid)

Description copied from interface: IAlleleRegistry

Blacklist an allele identified by its UID from mutation.

Specified by:

blacklistAllele in interface IAlleleRegistry

Parameters:

uid - UID of the allele to blacklist.

getAlleleBlacklist

public java.util.Collection<java.lang.String> getAlleleBlacklist()

Specified by:

getAlleleBlacklist in interface IAlleleRegistry

Returns:

Current blacklisted alleles.

isBlacklisted

public boolean isBlacklisted(java.lang.String uid)

Specified by:

isBlacklisted in interface IAlleleRegistry

Parameters:

uid - UID of the species to vet.

Returns:

true if the allele is blacklisted.

getSpeciesNoteStack

public net.minecraft.item.ItemStack getSpeciesNoteStack(com.mojang.authlib.GameProfile researcher,
                                                        IAlleleSpecies species)

Specified by:

getSpeciesNoteStack in interface IAlleleRegistry

Parameters:

researcher - Username of the player who researched this note.

species - IAlleleSpecies to encode on the research note.

Returns:

An itemstack containing a research note with the given species encoded onto it.

getMutationNoteStack

public net.minecraft.item.ItemStack getMutationNoteStack(com.mojang.authlib.GameProfile researcher,
                                                         IMutation mutation)

Specified by:

getMutationNoteStack in interface IAlleleRegistry

Parameters:

researcher - Username of the player who researched this note.

mutation - IMutation to encode on the research note.

Returns:

An itemstack containing a research note with the given mutation encoded onto it.