[jspwiki] 12/15: added Initializable interface on public api

[ju...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git

commit fc6d971687ab1f243ddb1661d6474da13fbf5d16
Author: juanpablo <ju...@apache.org>
AuthorDate: Tue Mar 24 21:49:06 2020 +0100

    added Initializable interface on public api
---
 .../org/apache/wiki/api/engine/Initializable.java  | 42 ++++++++++++++++++++++
 .../java/org/apache/wiki/api/engine/package.html   | 34 ++++++++++++++++++
 2 files changed, 76 insertions(+)

diff --git a/jspwiki-api/src/main/java/org/apache/wiki/api/engine/Initializable.java b/jspwiki-api/src/main/java/org/apache/wiki/api/engine/Initializable.java
new file mode 100644
index 0000000..39092a8
--- /dev/null
+++ b/jspwiki-api/src/main/java/org/apache/wiki/api/engine/Initializable.java
@@ -0,0 +1,42 @@
+/*
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+ */
+package org.apache.wiki.api.engine;
+
+import org.apache.wiki.api.core.Engine;
+import org.apache.wiki.api.exceptions.WikiException;
+
+import java.util.Properties;
+
+
+/**
+ * Marker interface for Engine's components that can be initialized.
+ */
+public interface Initializable {
+
+    /**
+     * <p>Initializes this Engine component. Note that the engine is not fully initialized at this
+     * point, so don't do anything fancy here - use lazy init, if you have to.<br/>&nbsp;</p>
+     *
+     * @param engine Engine performing the initialization.
+     * @param props Properties for setup.
+     * @throws WikiException if an exception occurs while initializing the component.
+     */
+    void initialize( Engine engine, Properties props ) throws WikiException;
+
+}
diff --git a/jspwiki-api/src/main/java/org/apache/wiki/api/engine/package.html b/jspwiki-api/src/main/java/org/apache/wiki/api/engine/package.html
new file mode 100644
index 0000000..cdc935d
--- /dev/null
+++ b/jspwiki-api/src/main/java/org/apache/wiki/api/engine/package.html
@@ -0,0 +1,34 @@
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+-->
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Engine Components</title>
+</head>
+<body>
+JSPWiki's Engine's component related classes.
+
+<h3>Package Specification</h3>
+
+<h3>Related Documentation</h3>
+
+</body>
+</html>
\ No newline at end of file