Field Detail

• throwsExceptions

  protected boolean throwsExceptions

  If true, some of the operations will throw BreadcrumbBarException.

Constructor Detail

• BreadcrumbBarCallBack

  public BreadcrumbBarCallBack()

Method Detail

• setup

  public void setup()
             throws BreadcrumbBarException

  Sets up the callback.

  Throws:

  BreadcrumbBarException - Runtime exception that wraps the cause. Is thrown only when setThrowsExceptions(boolean) has been called with true parameter.

• setThrowsExceptions

  public void setThrowsExceptions​(boolean throwsExceptions)

  Sets the indication whether the operations of this breadcrumb bar will throw BreadcrumbBarException.

  Parameters:

  throwsExceptions - If true, the operations of this breadcrumb bar will throw BreadcrumbBarException.

• getPathChoices

  public List<StringValuePair<T>> getPathChoices​(List<BreadcrumbItem<T>> path)
                                          throws BreadcrumbBarException

  Returns the choice element that corresponds to the specified path. If the path is empty, null should be returned. If path is null, the "root" elements should be returned

  Parameters:

  path - Breadcrumb bar path.

  Returns:

  The choice element that corresponds to the specified path

  Throws:

  BreadcrumbBarException - Runtime exception that wraps the cause. Is thrown only when setThrowsExceptions(boolean) has been called with true parameter.

• getLeafs

  public List<StringValuePair<T>> getLeafs​(List<BreadcrumbItem<T>> path)
                                    throws BreadcrumbBarException

  Returns the choice element that corresponds to the specified path. If the path is empty, null should be returned. If path is null, the "root" elements should be returned

  Parameters:

  path - Breadcrumb bar path.

  Returns:

  The choice element that corresponds to the specified path

  Throws:

  BreadcrumbBarException - Runtime exception that wraps the cause. Is thrown only when setThrowsExceptions(boolean) has been called with true parameter.

• getLeafContent

  public InputStream getLeafContent​(T leaf)
                             throws BreadcrumbBarException

  Returns the input stream with the leaf content. Some implementations may return null if this is not applicable.

  Parameters:

  leaf - Leaf.

  Returns:

  Input stream with the leaf content. May be null if this is not applicable.

  Throws:

  BreadcrumbBarException - Runtime exception that wraps the cause. Is thrown only when setThrowsExceptions(boolean) has been called with true parameter.