Continued:
[core.git] / framework / main / interfaces / lists / class_Listable.php
index 16f1bd7afc4abeab14bde3c7104898b47d2dfb59..ce6087e4f34ca1448352cc6511adf9c686bd35a9 100644 (file)
@@ -14,7 +14,7 @@ use \IteratorAggregate;
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
@@ -38,16 +38,16 @@ interface Listable extends FrameworkInterface, IteratorAggregate {
         * @param       $groupName      Group to check if found in list
         * @return      $isset          Whether the group is valid
         */
-       function isGroupSet ($groupName);
+       function isGroupSet (string $groupName);
 
        /**
-        * Adds the given group or if already added issues a ListGroupAlreadyAddedException
+        * Adds the given group or if already added issues a BadMethodCallException
         *
         * @param       $groupName      Group to add
         * @return      void
-        * @throws      ListGroupAlreadyAddedException  If the given group is already added
+        * @throws      BadMethodCallException  If the given group is already added
         */
-       function addGroup ($groupName);
+       function addGroup (string $groupName);
 
        /**
         * Adds the given instance to list group and sub group
@@ -56,9 +56,9 @@ interface Listable extends FrameworkInterface, IteratorAggregate {
         * @param       $subGroup                       Sub group to add instance to
         * @param       $visitableInstance      An instance of Visitable
         * @return      void
-        * @throws      NoListGroupException    If the given group is not found
+        * @throws      BadMethodCallException  If the given group is not found
         */
-       function addInstance ($groupName, $subGroup, Visitable $visitableInstance);
+       function addInstance (string $groupName, string $subGroup, Visitable $visitableInstance);
 
        /**
         * Adds the given entry to list group
@@ -66,9 +66,9 @@ interface Listable extends FrameworkInterface, IteratorAggregate {
         * @param       $groupName      Group to add instance to
         * @param       $entry          An entry of any type
         * @return      void
-        * @throws      NoListGroupException    If the given group is not found
+        * @throws      BadMethodCallException  If the given group is not found
         */
-       function addEntry ($groupName, $entry);
+       function addEntry (string $groupName, $entry);
 
        /**
         * Updates the given entry by hash with given array
@@ -78,7 +78,7 @@ interface Listable extends FrameworkInterface, IteratorAggregate {
         * @return      void
         * @throws      InvalidListHashException        If the solved hash index is invalid
         */
-       function updateCurrentEntryByHash ($hash, array $entryArray);
+       function updateCurrentEntryByHash (string $hash, array $entryArray);
 
        /**
         * "Getter" for an iterator instance of this list