Jake Slack | 03928ae | 2014-05-13 18:41:56 -0700 | [diff] [blame] | 1 | // |
| 2 | // ======================================================================== |
| 3 | // Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd. |
| 4 | // ------------------------------------------------------------------------ |
| 5 | // All rights reserved. This program and the accompanying materials |
| 6 | // are made available under the terms of the Eclipse Public License v1.0 |
| 7 | // and Apache License v2.0 which accompanies this distribution. |
| 8 | // |
| 9 | // The Eclipse Public License is available at |
| 10 | // http://www.eclipse.org/legal/epl-v10.html |
| 11 | // |
| 12 | // The Apache License v2.0 is available at |
| 13 | // http://www.opensource.org/licenses/apache2.0.php |
| 14 | // |
| 15 | // You may elect to redistribute this code under either of these licenses. |
| 16 | // ======================================================================== |
| 17 | // |
| 18 | |
| 19 | package org.eclipse.jetty.server; |
| 20 | |
| 21 | import org.eclipse.jetty.util.component.LifeCycle; |
| 22 | |
| 23 | /** |
| 24 | * A Handler that contains other Handlers. |
| 25 | * <p> |
| 26 | * The contained handlers may be one (see @{link {@link org.eclipse.jetty.server.handler.HandlerWrapper}) |
| 27 | * or many (see {@link org.eclipse.jetty.server.handler.HandlerList} or {@link org.eclipse.jetty.server.handler.HandlerCollection}. |
| 28 | * |
| 29 | */ |
| 30 | public interface HandlerContainer extends LifeCycle |
| 31 | { |
| 32 | /* ------------------------------------------------------------ */ |
| 33 | /** |
| 34 | * @return array of handlers directly contained by this handler. |
| 35 | */ |
| 36 | public Handler[] getHandlers(); |
| 37 | |
| 38 | /* ------------------------------------------------------------ */ |
| 39 | /** |
| 40 | * @return array of all handlers contained by this handler and it's children |
| 41 | */ |
| 42 | public Handler[] getChildHandlers(); |
| 43 | |
| 44 | /* ------------------------------------------------------------ */ |
| 45 | /** |
| 46 | * @param byclass |
| 47 | * @return array of all handlers contained by this handler and it's children of the passed type. |
| 48 | */ |
| 49 | public Handler[] getChildHandlersByClass(Class<?> byclass); |
| 50 | |
| 51 | /* ------------------------------------------------------------ */ |
| 52 | /** |
| 53 | * @param byclass |
| 54 | * @return first handler of all handlers contained by this handler and it's children of the passed type. |
| 55 | */ |
| 56 | public <T extends Handler> T getChildHandlerByClass(Class<T> byclass); |
| 57 | } |