David Jencks | cb9f942 | 2013-02-04 02:16:11 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | * or more contributor license agreements. See the NOTICE file |
| 4 | * distributed with this work for additional information |
| 5 | * regarding copyright ownership. The ASF licenses this file |
| 6 | * to you under the Apache License, Version 2.0 (the |
| 7 | * "License"); you may not use this file except in compliance |
| 8 | * with the License. You may obtain a copy of the License at |
| 9 | * |
| 10 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | * |
| 12 | * Unless required by applicable law or agreed to in writing, |
| 13 | * software distributed under the License is distributed on an |
| 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | * KIND, either express or implied. See the License for the |
| 16 | * specific language governing permissions and limitations |
| 17 | * under the License. |
| 18 | */ |
| 19 | package org.apache.felix.scr; |
| 20 | |
David Jencks | 652fad7 | 2013-02-04 02:16:16 +0000 | [diff] [blame] | 21 | import java.io.PrintWriter; |
David Jencks | cb9f942 | 2013-02-04 02:16:11 +0000 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * Abstraction of command interface. |
| 25 | * |
David Jencks | 652fad7 | 2013-02-04 02:16:16 +0000 | [diff] [blame] | 26 | * @Since 1.8 |
David Jencks | cb9f942 | 2013-02-04 02:16:11 +0000 | [diff] [blame] | 27 | */ |
| 28 | public interface ScrInfo |
| 29 | { |
| 30 | |
| 31 | /** |
| 32 | * List in text the components for the bundle specified, or all components if null, sorted by component ID |
| 33 | * @param bundleIdentifier bundle the components are in or null for all components |
| 34 | * @param out PrintStream for normal output |
David Jencks | 652fad7 | 2013-02-04 02:16:16 +0000 | [diff] [blame] | 35 | * @throws IllegalArgumentException if nothing can be found |
David Jencks | cb9f942 | 2013-02-04 02:16:11 +0000 | [diff] [blame] | 36 | */ |
David Jencks | 652fad7 | 2013-02-04 02:16:16 +0000 | [diff] [blame] | 37 | void list(String bundleIdentifier, PrintWriter out); |
David Jencks | cb9f942 | 2013-02-04 02:16:11 +0000 | [diff] [blame] | 38 | |
| 39 | /** |
| 40 | * List in text detailed information about the specified components. Components can be specified by |
| 41 | * numeric componentId, component name, a regexp to match for component name, or null for all components. |
| 42 | * @param componentId specifier for desired components |
| 43 | * @param out PrintStream for normal output |
David Jencks | 652fad7 | 2013-02-04 02:16:16 +0000 | [diff] [blame] | 44 | * @throws IllegalArgumentException if nothing can be found |
David Jencks | cb9f942 | 2013-02-04 02:16:11 +0000 | [diff] [blame] | 45 | */ |
David Jencks | 652fad7 | 2013-02-04 02:16:16 +0000 | [diff] [blame] | 46 | void info(String componentId, PrintWriter out); |
David Jencks | cb9f942 | 2013-02-04 02:16:11 +0000 | [diff] [blame] | 47 | |
| 48 | /** |
| 49 | * List in text the current SCR configuration |
| 50 | * @param out PrintStream for output. |
| 51 | */ |
David Jencks | 652fad7 | 2013-02-04 02:16:16 +0000 | [diff] [blame] | 52 | void config(PrintWriter out); |
David Jencks | cb9f942 | 2013-02-04 02:16:11 +0000 | [diff] [blame] | 53 | |
| 54 | } |