forestry.api.genetics

Interface IAlleleRegistry

All Known Implementing Classes:

AlleleRegistry

public interface IAlleleRegistry

Manages ISpeciesRoot, IAlleles, IFruitFamilys, IClassification, the blacklist and allows creation of research notes.

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.
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 classification) Registers a classification.
void	registerDeprecatedAlleleReplacement(java.lang.String deprecatedAlleleUID, IAllele replacement) 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.

Method Detail

registerSpeciesRoot

void registerSpeciesRoot(ISpeciesRoot root)

Register a ISpeciesRoot.

Parameters:

root - ISpeciesRoot to register.

getSpeciesRoot

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

Returns:

Map of all registered ISpeciesRoot.

getSpeciesRoot

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

Retrieve the ISpeciesRoot with the given uid.

Parameters:

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

Returns:

ISpeciesRoot if it exists, null otherwise.

getSpeciesRoot

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

Retrieve a matching ISpeciesRoot for the given itemstack.

Parameters:

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

Returns:

ISpeciesRoot if found, null otherwise.

getSpeciesRoot

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

Retrieve a matching ISpeciesRoot for the given IIndividual-class.

Parameters:

individualClass - Class extending IIndividual.

Returns:

ISpeciesRoot if found, null otherwise.

getSpeciesRoot

ISpeciesRoot getSpeciesRoot(IIndividual individual)

Retrieve a matching ISpeciesRoot for the given IIndividual

isIndividual

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

Tests the itemstack for genetic information.

Returns:

true if the itemstack is an individual.

getIndividual

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

Retrieve genetic information from an itemstack.

Parameters:

stack - Stack to retrieve genetic information for.

Returns:

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

getRegisteredAlleles

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

Returns:

HashMap of all currently registered alleles.

getRegisteredAlleles

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

Returns:

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

Since:

Forestry 4.2

registerAllele

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

Registers an allele.

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

Parameters:

allele - IAllele to register.

chromosomeTypes - valid chromosomeTypes for this allele.

Since:

Forestry 4.2

addValidAlleleTypes

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

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

Since:

Forestry 5.3.1

getDeprecatedAlleleReplacements

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

Returns:

HashMap of all registered deprecated alleles and their corresponding replacements

registerDeprecatedAlleleReplacement

void registerDeprecatedAlleleReplacement(java.lang.String deprecatedAlleleUID,
                                         IAllele replacement)

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

Parameters:

deprecatedAlleleUID - the old allele's UID

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

getAllele

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

Gets an allele

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.

getChromosomeTypes

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

Returns:

unmodifiable collection of all the known chromosome types.

Since:

Forestry 5.0

getRegisteredClassifications

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

Returns:

HashMap of all currently registered classifications.

registerClassification

void registerClassification(IClassification classification)

Registers a classification.

Parameters:

classification - IClassification to register.

createAndRegisterClassification

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

Creates and returns a classification.

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

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

getClassification

IClassification getClassification(java.lang.String uid)

Gets a classification.

Parameters:

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

Returns:

IClassification if found, null otherwise.

getRegisteredFruitFamilies

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

Get all registered fruit families.

Returns:

A map of registered fruit families and their UIDs.

registerFruitFamily

void registerFruitFamily(IFruitFamily family)

Registers a new fruit family.

getFruitFamily

IFruitFamily getFruitFamily(java.lang.String uid)

Retrieves a fruit family identified by uid.

Returns:

{IFruitFamily} if found, false otherwise.

registerAlleleHandler

void registerAlleleHandler(IAlleleHandler handler)

Registers a new IAlleleHandler

Parameters:

handler - IAlleleHandler to register.

blacklistAllele

void blacklistAllele(java.lang.String uid)

Blacklist an allele identified by its UID from mutation.

Parameters:

uid - UID of the allele to blacklist.

getAlleleBlacklist

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

Returns:

Current blacklisted alleles.

isBlacklisted

boolean isBlacklisted(java.lang.String uid)

Parameters:

uid - UID of the species to vet.

Returns:

true if the allele is blacklisted.

getSpeciesNoteStack

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

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

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

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.