How do I ensure a Java Object is of type Map<String, Object>

Question

Short, at-a-glance summary of question (TLDR): how do I ensure a Java Object is of type Map<String, Object>?

I have a YAML document as a String. I create the YAML using SnakeYAML from a Map<String, Object> but it could be tampered with before I read it back again. I don't want to resort to PKI signing, it's enough to see whether the YAML representation is still a Map<String, Object>, even if the Object values may be all over the place. I care about type, not content.

So: how do I ensure an Object is indeed of type Map<String, Object>?

Here's how I am trying to circumvent the various SuppressWarnings of type erasure:

Object yamlObject = yaml.load(someYamlDocumentAsString);
// I only want to proceed if this YAML object is a Map<String, Object>
if ((yamlObject instanceof Map<?, ?>)) {
  Map<?, ?> propertyMap = (Map<?, ?>) yamlObject;
  for (Entry<?, ?> propertyEntry : propertyMap.entrySet()) {
    // I am checking each key and throwing if it's not a "String"
    Object propertyKey = propertyEntry.getKey();
    if (!(propertyKey instanceof CharSequence)) {
      throw new BananaException("FIXME"); // FIXME
    }
  }
} else {
  throw new CoconutException("FIXME"); // FIXME
}

Can the above be done better?

Incidentally, I don't suppose Java has something akin to C#'s as keyword (from MSDN: The as operator is like a cast operation. However, if the conversion is not possible, as returns null instead of raising an exception.)?

After the code above, can I safely suppress warnings for this:

@SuppressWarnings("unchecked")
Map<String, Object> aBeautifulAndCozyMap = (Map<String, Object>) propertyMap;

I don't believe I've ever heard of a better exception than CoconutException, although it sounds almost as painful to catch as the dreaded PineappleException. — BlackVegetable
– BlackVegetable, Commented Sep 11, 2012 at 17:45
Not the worst of spiky fruit. Imaging catching a huge litchi! — Robottinosino
– Robottinosino, Commented Sep 11, 2012 at 17:48
A well thrown PineconeException (en.wikipedia.org/wiki/Conifer_cone) can leave a welt. — Edwin Buck
– Edwin Buck, Commented Sep 11, 2012 at 19:03

Alex · Accepted Answer · 2012-09-11 18:44:59Z

1

Because of type erasure, information is not known at runtime, so there is no other way of checking it than instanceof, getClass().getName() or getDeclaredField("...").getGenericType().getActualTypeArguments() things.

In my opinion you should stay with instanceof as it is easily readable and other developer will easily understand what you wanted to do.

PS: I liked the exceptions ;-)

answered Sep 11, 2012 at 18:44

Alex

25.7k6 gold badges63 silver badges56 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How do I ensure a Java Object is of type Map<String, Object>

Can the above be done better?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

Can the above be done better?

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related