Add type hintings in ConstantPool

chitoku-k · chitoku-k · commit 57e9dc626fe4 · 2019-05-07T14:30:57.000+09:00
diff --git a/src/Core/JVM/ConstantPool.php b/src/Core/JVM/ConstantPool.php
@@ -51,6 +51,9 @@ public function __construct(ReaderInterface $reader, int $entries)
         }
     }
 
+    /**
+     * @return StructureInterface[]
+     */
     public function getEntries(): array
     {
         return $this->entries;
@@ -94,31 +97,49 @@ private function read($entryTag): ?StructureInterface
         throw new ReadEntryException('Entry tag ' . sprintf('0x%04X', $entryTag) . ' is not defined.');
     }
 
+    /**
+     * @return boolean
+     */
     public function offsetExists($offset)
     {
         return isset($this->entries[$offset]);
     }
 
+    /**
+     * @return StructureInterface
+     */
     public function offsetGet($offset)
     {
         return $this->entries[$offset];
     }
 
+    /**
+     * @return int
+     */
     public function count()
     {
         return count($this->entries);
     }
 
+    /**
+     * @throws ReadOnlyException
+     */
     public function offsetSet($offset, $value)
     {
         throw new ReadOnlyException('You cannot rewrite datum. The Constant Pool is read-only.');
     }
 
+    /**
+     * @throws ReadOnlyException
+     */
     public function offsetUnset($offset)
     {
         throw new ReadOnlyException('You cannot rewrite datum. The Constant Pool is read-only.');
     }
 
+    /**
+     * @return \ArrayIterator<StructureInterface>
+     */
     public function getIterator()
     {
         return new \ArrayIterator($this->entries);

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,9 @@ public function __construct(ReaderInterface $reader, int $entries)`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`
	`54`	`+ /**`
	`55`	`+ * @return StructureInterface[]`
	`56`	`+ */`
`54`	`57`	`public function getEntries(): array`
`55`	`58`	`{`
`56`	`59`	`return $this->entries;`
`@@ -94,31 +97,49 @@ private function read($entryTag): ?StructureInterface`
`94`	`97`	`throw new ReadEntryException('Entry tag ' . sprintf('0x%04X', $entryTag) . ' is not defined.');`
`95`	`98`	`}`
`96`	`99`
	`100`	`+ /**`
	`101`	`+ * @return boolean`
	`102`	`+ */`
`97`	`103`	`public function offsetExists($offset)`
`98`	`104`	`{`
`99`	`105`	`return isset($this->entries[$offset]);`
`100`	`106`	`}`
`101`	`107`
	`108`	`+ /**`
	`109`	`+ * @return StructureInterface`
	`110`	`+ */`
`102`	`111`	`public function offsetGet($offset)`
`103`	`112`	`{`
`104`	`113`	`return $this->entries[$offset];`
`105`	`114`	`}`
`106`	`115`
	`116`	`+ /**`
	`117`	`+ * @return int`
	`118`	`+ */`
`107`	`119`	`public function count()`
`108`	`120`	`{`
`109`	`121`	`return count($this->entries);`
`110`	`122`	`}`
`111`	`123`
	`124`	`+ /**`
	`125`	`+ * @throws ReadOnlyException`
	`126`	`+ */`
`112`	`127`	`public function offsetSet($offset, $value)`
`113`	`128`	`{`
`114`	`129`	`throw new ReadOnlyException('You cannot rewrite datum. The Constant Pool is read-only.');`
`115`	`130`	`}`
`116`	`131`
	`132`	`+ /**`
	`133`	`+ * @throws ReadOnlyException`
	`134`	`+ */`
`117`	`135`	`public function offsetUnset($offset)`
`118`	`136`	`{`
`119`	`137`	`throw new ReadOnlyException('You cannot rewrite datum. The Constant Pool is read-only.');`
`120`	`138`	`}`
`121`	`139`
	`140`	`+ /**`
	`141`	`+ * @return \ArrayIterator<StructureInterface>`
	`142`	`+ */`
`122`	`143`	`public function getIterator()`
`123`	`144`	`{`
`124`	`145`	`return new \ArrayIterator($this->entries);`