X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Finterfaces%2Fclass_FrameworkInterface.php;h=88b30bf2a8420c92be395160343eccbff9845a97;hb=202f8c1c1d46d1292918b7110547952446a53391;hp=5848674c54c2ead573fd75057a7975b4185b4df3;hpb=0cd57c3885f00ad77fc599e53ed2f2d5e7ac267f;p=core.git diff --git a/inc/classes/interfaces/class_FrameworkInterface.php b/inc/classes/interfaces/class_FrameworkInterface.php index 5848674c..88b30bf2 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, 2008 Roland Haeder, 2009 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 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] ?>