ensembl-hive
2.6
|
Public Member Functions | |
public Boolean | check_ref_pp () |
public Boolean | assert_ref_pp () |
public Boolean | assert_array_contents () |
public Boolean | check_array_contents () |
public Boolean | assert_hash_contents () |
public Boolean | check_hash_contents () |
public Array | wrap_array () |
public CodeRef | check_ref_can () |
public Boolean | assert_ref_can () |
public Boolean | assert_numeric_pp () |
public Boolean | assert_integer_pp () |
public Boolean | assert_boolean () |
public Boolean | assert_strand () |
public Boolean | assert_file_handle () |
public ArrayRef | split_array () |
public Bio::EnsEMBL::Utils::Scalar::ScopeGuard | scope_guard () |
A collection of subroutines aimed to helping Scalar based operations
public Boolean Bio::EnsEMBL::Utils::Scalar::assert_array_contents | ( | ) |
Arg [1] : ArrayRef references to check Arg [2] : The type we expect Arg [3] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given objects/refs are what you expect. This behaves in an identical manner as assert_ref does works on an array ref of references
You can turn assertions off by using the global variable $Bio::EnsEMBL::Utils::Scalar::ASSERTIONS = 0 Returntype : Boolean; true if we managed to get to the return Example :
Exceptions : Throws is references argument is not an ArrayRef, also if the expected type was not set and if the given reference was not assignable to the expected value. Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::assert_boolean | ( | ) |
Arg [1] : The Scalar to check Arg [2] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given scalar is a boolean i.e. value is set to 1 or 0
You can turn assertions off by using the global variable $Bio::EnsEMBL::Utils::Scalar::ASSERTIONS = 0 Returntype : Boolean; true if we were given a boolean otherwise we signal failure via exceptions Example :
Exceptions : See assert_integer and we raise exceptions if the value was not equal to the 2 valid states Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::assert_file_handle | ( | ) |
Arg [1] : The Scalar to check Arg [2] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given scalar is actually a file handle. This will handle those which are Glob references and those which inherit from IO::Handle. It will also cope with a blessed Glob reference.
You can turn assertions off by using the global variable $Bio::EnsEMBL::Utils::Scalar::ASSERTIONS = 0 Returntype : Boolean; Example :
Exceptions : Raised if not defined, not a reference and was not a GLOB or did not inherit from IO::Handle Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::assert_hash_contents | ( | ) |
Arg [1] : HashRef references to check Arg [2] : The type we expect Arg [3] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given objects/refs are what you expect. This behaves in an identical manner as assert_ref does works on a HashRef of references. Hash keys are always Strings so do not need asserting.
You can turn assertions off by using the global variable $Bio::EnsEMBL::Utils::Scalar::ASSERTIONS = 0 Returntype : Boolean; true if we managed to get to the return Example :
Exceptions : Throws is references argument is not an ArrayRef, also if the expected type was not set and if the given reference was not assignable to the expected value. Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::assert_integer_pp | ( | ) |
Arg [1] : The Scalar to check Arg [2] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given scalar is a whole integer; we delegate to assert_numeric for number checking.
You can turn assertions off by using the global variable $Bio::EnsEMBL::Utils::Scalar::ASSERTIONS = 0 Returntype : Boolean; true if we had a numeric otherwise we signal failure via exceptions Example :
Exceptions : See assert_numeric and we raise exceptions if the value was not a whole integer Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::assert_numeric_pp | ( | ) |
Arg [1] : The Scalar to check Arg [2] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given scalar is number or not. If not then we raise exceptions detailing why
You can turn assertions off by using the global variable $Bio::EnsEMBL::Utils::Scalar::ASSERTIONS = 0 Returntype : Boolean; true if we had a numeric otherwise we signal failure via exceptions Example :
Exceptions : If the Scalar is not defined, if the Scalar was blessed and if the value was not a number Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::assert_ref_can | ( | ) |
Arg [1] : The reference to check Arg [2] : The method we expect to run Arg [3] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given object/ref is implements the given method. Will throw exceptions.
You can turn assertions off by using the global variable $Bio::EnsEMBL::Utils::Scalar::ASSERTIONS = 0 Returntype : Boolean; true if we managed to get to the return Example :
Exceptions : If the reference is not defined, if the object does not implement the given method and if no method was given to check Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::assert_ref_pp | ( | ) |
Arg [1] : The reference to check Arg [2] : The type we expect Arg [3] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given object/ref is what you expect. This behaves in an identical manner as check_ref() does except this will raise exceptions when the values do not match rather than returning a boolean indicating the situation.
Undefs cause exception circumstances.
You can turn assertions off by using the global variable $Bio::EnsEMBL::Utils::Scalar::ASSERTIONS = 0 Returntype : Boolean; true if we managed to get to the return Example :
Exceptions : If the expected type was not set and if the given reference was not assignable to the expected value Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::assert_strand | ( | ) |
Arg [1] : The Scalar to check Arg [2] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given scalar is a whole integer and if the value is set to 1, 0 or -1
You can turn assertions off by using the global variable $Bio::EnsEMBL::Utils::Scalar::ASSERTIONS = 0 Returntype : Boolean; true if we had a strand integer otherwise we signal failure via exceptions Example :
Exceptions : See assert_integer and we raise exceptions if the value was not equal to the 3 valid states Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::check_array_contents | ( | ) |
Arg [1] : ArrayRef references to check Arg [2] : The type we expect Arg [3] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given objects/refs are what you expect. Returntype : Boolean; true if all contents were as expected Example :
Exceptions : Thrown if no type was given Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::check_hash_contents | ( | ) |
Arg [1] : HashRef references to check Arg [2] : The type we expect Arg [3] : The attribute name you are asserting; not required but allows for more useful error messages to be generated. Defaults to -Unknown-. Description : A subroutine which checks to see if the given objects/refs are what you expect. Returntype : Boolean; true if all contents were as expected Example :
Exceptions : Thrown if no type was given Status : Stable
public CodeRef Bio::EnsEMBL::Utils::Scalar::check_ref_can | ( | ) |
Arg [1] : The reference to check Arg [2] : The method we expect to run Description : A subroutine which checks to see if the given object/ref is implements the given method. This is very similar to the functionality given by UNIVERSAL::can() but works by executing can() on the object meaning we consult the object's potentially overriden version rather than Perl's default mechanism. Returntype : CodeRef Example :
Exceptions : If the expected type was not set. Status : Stable
public Boolean Bio::EnsEMBL::Utils::Scalar::check_ref_pp | ( | ) |
Arg [1] : The reference to check Arg [2] : The type we expect Description : A subroutine which checks to see if the given object/ref is what you expect. If you give it a blessed reference then it will perform an isa() call on the object after the defined tests. If it is a plain reference then it will use ref().
An undefined value will return a false. Returntype : Boolean indicating if the reference was the type we expect Example :
Exceptions : If the expected type was not set Status : Stable
public Bio::EnsEMBL::Utils::Scalar::ScopeGuard Bio::EnsEMBL::Utils::Scalar::scope_guard | ( | ) |
Arg [1] : CodeRef The block of code to exit once it escapes out of scope Description : Simple subroutine which blesses your given code reference into a Bio::EnsEMBL::Utils::Scalar::ScopeGuard object. This has a DESTROY implemented which will cause the code reference to execute once the object goes out of scope and its reference count hits 0. Returntype : Bio::EnsEMBL::Utils::Scalar::ScopeGuard Example :
Exceptions : Raised if argument was not a CodeRef Status : Stable
public ArrayRef Bio::EnsEMBL::Utils::Scalar::split_array | ( | ) |
Arg [1] : Integer Maximum size of an array produced Arg [2] : ArrayRef The array to split Description : Takes an array of values and splits the array into multiple arrays where the maximum size of each array is as specified Example :
Returntype : ArrayRef of ArrayRefs where each element is a split list
public Array Bio::EnsEMBL::Utils::Scalar::wrap_array | ( | ) |
Arg : The reference we want to wrap in an array Description : Takes in a reference and returns either the reference if it was already an array, the reference wrapped in an array or an empty array (if the given value was undefined). Returntype : Array Reference Example :
Exceptions : None Status : Stable