Class Finder.ByNameFinder

  • Enclosing class:
    Finder

    public static final class Finder.ByNameFinder
    extends java.lang.Object
    Search for any first element by simple name among the given root element(s) and direct children of root element(s)
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends Element>
      T
      find​(Element root, java.lang.Class[] type, java.lang.String name)
      Find element by name.
      <T extends Element>
      T
      find​(Element root, java.lang.Class[] type, java.lang.String name, boolean includeRoot)
      Find element by name.
      <T extends Element>
      T
      find​(Element root, java.lang.Class type, java.lang.String name)
      Find element by name.
      <T extends Element>
      T
      find​(Element root, java.lang.Class type, java.lang.String name, boolean includeRoot)
      Find element by name.
      <T extends Element>
      T
      find​(java.util.Collection<? extends Element> roots, java.lang.Class[] type, java.lang.String name)
      Find element by name.
      <T extends Element>
      T
      find​(java.util.Collection<? extends Element> roots, java.lang.Class[] type, java.lang.String name, boolean includeRoot)
      Find element by name.
      <T extends Element>
      T
      find​(java.util.Collection<? extends Element> roots, java.lang.Class type, java.lang.String name)
      Find element by name.
      <T extends Element>
      T
      find​(java.util.Collection<? extends Element> roots, java.lang.Class type, java.lang.String name, boolean includeRoot)
      Find element by name.
      <T extends Element>
      T
      findFirstInCollection​(java.util.Collection<T> elements, java.lang.String name)
      Find first NameElement in a given collection with a given name
      <T extends Element>
      java.util.Collection<T>
      findInCollection​(java.util.Collection<T> elements, java.lang.String name)
      Find NameElements in a given collection with a given name
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • find

        @CheckForNull
        public <T extends Element> T find​(Element root,
                                          @CheckForNull
                                          java.lang.Class type,
                                          java.lang.String name)
        Find element by name. Include root(s) into a search.
        Parameters:
        root - root element
        type - strict class type of element. Nulls means any element
        name - Element name
        Returns:
        found Element or null
      • find

        @CheckForNull
        public <T extends Element> T find​(Element root,
                                          @CheckForNull
                                          java.lang.Class[] type,
                                          java.lang.String name)
        Find element by name. Include root(s) into a search.
        Parameters:
        root - root element
        type - strict class types of element. Nulls means any element
        name - Element name
        Returns:
        found Element or null
      • find

        @CheckForNull
        public <T extends Element> T find​(Element root,
                                          @CheckForNull
                                          java.lang.Class type,
                                          java.lang.String name,
                                          boolean includeRoot)
        Find element by name.
        Parameters:
        root - root element
        type - strict class type of element. Nulls means any element
        name - Element name
        includeRoot - include root element into a search
        Returns:
        found Element or null
      • find

        @CheckForNull
        public <T extends Element> T find​(Element root,
                                          @CheckForNull
                                          java.lang.Class[] type,
                                          java.lang.String name,
                                          boolean includeRoot)
        Find element by name.
        Parameters:
        root - root element
        type - strict class types of element. Nulls means any element
        name - Element name
        includeRoot - include root element into a search
        Returns:
        found Element or null
      • find

        @CheckForNull
        public <T extends Element> T find​(java.util.Collection<? extends Element> roots,
                                          @CheckForNull
                                          java.lang.Class[] type,
                                          java.lang.String name)
        Find element by name. Include root(s) into a search.
        Parameters:
        roots - root elements
        type - strict class types of element. Nulls means any element
        name - Element name
        Returns:
        found Element or null
      • find

        @CheckForNull
        public <T extends Element> T find​(java.util.Collection<? extends Element> roots,
                                          @CheckForNull
                                          java.lang.Class type,
                                          java.lang.String name)
        Find element by name. Include root(s) into a search.
        Parameters:
        roots - root elements
        type - strict class type of element. Nulls means any element
        name - Element name
        Returns:
        found Element or null
      • find

        @CheckForNull
        public <T extends Element> T find​(java.util.Collection<? extends Element> roots,
                                          @CheckForNull
                                          java.lang.Class type,
                                          java.lang.String name,
                                          boolean includeRoot)
        Find element by name.
        Parameters:
        roots - root element
        type - strict class type of element. Nulls means any element
        name - Element name
        includeRoot - include root element into a search
        Returns:
        found Element or null
      • find

        @CheckForNull
        public <T extends Element> T find​(java.util.Collection<? extends Element> roots,
                                          @CheckForNull
                                          java.lang.Class[] type,
                                          java.lang.String name,
                                          boolean includeRoot)
        Find element by name.
        Parameters:
        roots - root element
        type - strict class types of element. Nulls means any element
        name - Element name
        includeRoot - include root element into a search
        Returns:
        found Element or null
      • findInCollection

        public <T extends Element> java.util.Collection<T> findInCollection​(java.util.Collection<T> elements,
                                                                            java.lang.String name)
        Find NameElements in a given collection with a given name
        Parameters:
        elements - elements
        name - element name
        Returns:
        found Elements
      • findFirstInCollection

        @CheckForNull
        public <T extends Element> T findFirstInCollection​(java.util.Collection<T> elements,
                                                           java.lang.String name)
        Find first NameElement in a given collection with a given name
        Parameters:
        elements - elements
        name - element name
        Returns:
        found Element