modules/tool-classfile/src/main/java/net/multiphasicapps/classfile/AttributeTable.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package net.multiphasicapps.classfile;
  11
  12 import cc.squirreljme.runtime.cldc.debug.Debugging;
  13 import java.io.DataInputStream;
  14 import java.io.IOException;
  15 import java.util.Arrays;
  16 import java.util.LinkedHashMap;
  17 import java.util.Map;
  18
  19 /**
  20  * This represents the attribute table that exists within a class.
  21  *
  22  * @since 2018/05/14
  23  */
  24 public final class AttributeTable
  25 {
  26         /** The attribute table. */
  27         private final Map<String, Attribute> _attributes;
  28
  29         /**
  30          * Initializes the attribute table.
  31          *
  32          * @param __a The input attributes.
  33          * @throws NullPointerException On null arguments.
  34          * @since 2018/05/15
  35          */
  36         public AttributeTable(Attribute... __a)
  37                 throws NullPointerException
  38         {
  39                 this(Arrays.<Attribute>asList((__a != null ? __a :
  40                         new Attribute[0])));
  41         }
  42
  43         /**
  44          * Initializes the attribute table.
  45          *
  46          * @param __a The input attributes.
  47          * @throws NullPointerException On null arguments.
  48          * @since 2018/05/15
  49          */
  50         public AttributeTable(Iterable<Attribute> __a)
  51                 throws NullPointerException
  52         {
  53                 if (__a == null)
  54                         throw new NullPointerException("NARG");
  55
  56                 Map<String, Attribute> attributes = new LinkedHashMap<>();
  57                 for (Attribute a : __a)
  58                 {
  59                         if (a == null)
  60                                 throw new NullPointerException("NARG");
  61
  62                         String n = a.name();
  63                         if (!attributes.containsKey(n))
  64                                 attributes.put(n, a);
  65                 }
  66                 this._attributes = attributes;
  67         }
  68
  69         /**
  70          * {@inheritDoc}
  71          * @since 2018/05/15
  72          */
  73         @Override
  74         public final boolean equals(Object __o)
  75         {
  76                 throw Debugging.todo();
  77         }
  78
  79         /**
  80          * Returns the attribute that uses the specified name.
  81          *
  82          * @param __n The name of the attribute to get.
  83          * @return The specified attribute or {@code null} if it does not exist.
  84          * @throws NullPointerException On null arguments.
  85          * @since 2018/05/15
  86          */
  87         public final Attribute get(String __n)
  88                 throws NullPointerException
  89         {
  90                 if (__n == null)
  91                         throw new NullPointerException("NARG");
  92
  93                 return this._attributes.get(__n);
  94         }
  95
  96         /**
  97          * {@inheritDoc}
  98          * @since 2018/05/15
  99          */
 100         @Override
 101         public final int hashCode()
 102         {
 103                 throw Debugging.todo();
 104         }
 105
 106         /**
 107          * Opens the attribute by the specified key.
 108          *
 109          * @param __n The name of the attribute to open.
 110          * @return The stream to the given attribute or {@code null} if it is not
 111          * valid.
 112          * @throws NullPointerException On null arguments.
 113          * @since 2018/05/15
 114          */
 115         public final DataInputStream open(String __n)
 116                 throws NullPointerException
 117         {
 118                 if (__n == null)
 119                         throw new NullPointerException("NARG");
 120
 121                 Attribute a = this.get(__n);
 122                 if (a == null)
 123                         return null;
 124                 return a.open();
 125         }
 126
 127         /**
 128          * {@inheritDoc}
 129          * @since 2018/05/15
 130          */
 131         @Override
 132         public final String toString()
 133         {
 134                 throw Debugging.todo();
 135         }
 136
 137         /**
 138          * Returns the length of the attribute table.
 139          *
 140          * @return The attribute table length.
 141          * @since 2018/05/14
 142          */
 143         public final int size()
 144         {
 145                 return this._attributes.size();
 146         }
 147
 148         /**
 149          * Parses the attribute table.
 150          *
 151          * @param __in The input stream.
 152          * @param __pool The constant pool.
 153          * @return The attribute table.
 154          * @throws InvalidClassFormatException If the table is not correct.
 155          * @throws IOException On read errors.
 156          * @throws NullPointerException On null arguments.
 157          * @since 2018/05/14
 158          */
 159         public static AttributeTable parse(Pool __pool, DataInputStream __in)
 160                 throws InvalidClassFormatException, IOException, NullPointerException
 161         {
 162                 if (__in == null || __pool == null)
 163                         throw new NullPointerException("NARG");
 164
 165                 int n = __in.readUnsignedShort();
 166                 Attribute[] rv = new Attribute[n];
 167
 168                 // Read each entry
 169                 for (int i = 0; i < n; i++)
 170                 {
 171                         String name = __pool.<UTFConstantEntry>require(
 172                                 UTFConstantEntry.class, __in.readUnsignedShort()).toString();
 173
 174                         // {@squirreljme.error JC1x Attributes with a size larger than two
 175                         // gigabytes are not supported.}
 176                         int len = __in.readInt();
 177                         if (len < 0)
 178                                 throw new InvalidClassFormatException("JC1x");
 179
 180                         byte[] data = new byte[len];
 181                         __in.readFully(data);
 182
 183                         rv[i] = new Attribute(name, data, 0, len);
 184                 }
 185
 186                 return new AttributeTable(rv);
 187         }
 188 }
 189