X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Finterfaces%2Fclass_FrameworkInterface.php;h=101f1e44018d0cd4a80e617a8861f187e869db15;hb=e9c140f13fa2083abe974e44fc25a305856127bf;hp=d05344a940ade0b6414b969f364ae40d9950c856;hpb=361e6320e50a8bb1a3ccb675388b8042361669ae;p=core.git diff --git a/inc/classes/interfaces/class_FrameworkInterface.php b/inc/classes/interfaces/class_FrameworkInterface.php index d05344a9..101f1e44 100644 --- a/inc/classes/interfaces/class_FrameworkInterface.php +++ b/inc/classes/interfaces/class_FrameworkInterface.php @@ -3,11 +3,12 @@ * This is the top-level interface for all other interfaces and should contain * method stubs which is being used in every class * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007 - 2009 Roland Haeder, this is free software + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @link http://www.shipsimu.org + * @todo Find a better name for this interface * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -31,7 +32,23 @@ interface FrameworkInterface { * @throws NullPointerException If the result instance is null */ function getField ($fieldName); + + /** + * Checks whether an object equals this object. You should overwrite this + * method to implement own equality checks + * + * @param $objectInstance An instance of a FrameworkInterface object + * @return $equals Whether both objects equals + */ + function equals (FrameworkInterface $objectInstance); + + /** + * Generates a code for hashes from this class + * + * @return $hashCode The hash code respresenting this class + */ + function hashCode (); } -// +// [EOF] ?>