1 /*
2 * #%L
3 * wcm.io
4 * %%
5 * Copyright (C) 2015 wcm.io
6 * %%
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * #L%
19 */
20 package io.wcm.caravan.hal.docs;
21
22 import org.osgi.framework.Bundle;
23
24 /**
25 * Creates {@link HalDocsAugmenter} instances for JAX-RS application bundles.
26 */
27 public interface HalDocsAugmenterFactory {
28
29 /**
30 * Create {@link HalDocsAugmenter} for the given bundle.
31 * @param bundle JAX-RS application bundle. May be null.
32 * @return Augmenter (never null, but it does nothing if bundle is null or no documentation metadata is found)
33 */
34 HalDocsAugmenter create(Bundle bundle);
35
36 }