Constructor Detail

• Yamls

  public Yamls()

Method Detail

• getAs

  public static <T> T getAs(java.lang.Object x,
            java.lang.Class<T> type)

  returns the given (yaml-parsed) object as the given yaml type.

  if the object is an iterable or iterator this method will fully expand it as a list. if the requested type is not an iterable or iterator, and the list contains a single item, this will take that single item.

  in other cases this method simply does a type-check and cast (no other type coercion).

  Throws:

  java.lang.IllegalArgumentException - if the input is an iterable not containing a single element, and the cast is requested to a non-iterable type

  java.lang.ClassCastException - if cannot be casted

• getAt

  @Beta
  public static java.lang.Object getAt(java.lang.String yaml,
                            java.util.List<java.lang.String> path)

  Parses the given yaml, and walks the given path to return the referenced object.

  See Also:

  #getAt(Object, List)

• getAtPreParsed

  @Beta
  public static java.lang.Object getAtPreParsed(java.lang.Object current,
                                     java.util.List<java.lang.String> path)

  For pre-parsed yaml, walks the maps/lists to return the given sub-item. In the given path:

  • A vanilla string is assumed to be a key into a map.
  • A string in the form like "[0]" is assumed to be an index into a list

  Also see Jsonya, such as Jsonya.of(current).at(path).get().

  Returns:

  The object at the given path, or null if that path does not exist.

• dump

  public static void dump(int depth,
          java.lang.Object r)

• parseAll

  public static java.lang.Iterable<java.lang.Object> parseAll(java.lang.String yaml)

  simplifies new Yaml().loadAll, and converts to list to prevent single-use iterable bug in yaml

• parseAll

  public static java.lang.Iterable<java.lang.Object> parseAll(java.io.Reader yaml)

  as parseAll(String)

• removeMultinameAttribute

  public static java.lang.Object removeMultinameAttribute(java.util.Map<java.lang.String,java.lang.Object> obj,
                                          java.lang.String... equivalentNames)

• getMultinameAttribute

  public static java.lang.Object getMultinameAttribute(java.util.Map<java.lang.String,java.lang.Object> obj,
                                       java.lang.String... equivalentNames)

• getTextOfYamlAtPath

  public static Yamls.YamlExtract getTextOfYamlAtPath(java.lang.String yaml,
                                      java.lang.Object... path)

  Given a path, where each segment consists of a string (key) or number (element in list), this will find the YAML text for that element

  If not found this will return a Yamls.YamlExtract where YamlExtract#isMatch() is false and Yamls.YamlExtract.getError() is set.