diff options
Diffstat (limited to 'src/org/jivesoftware/smackx/commands/LocalCommandFactory.java')
-rw-r--r-- | src/org/jivesoftware/smackx/commands/LocalCommandFactory.java | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/src/org/jivesoftware/smackx/commands/LocalCommandFactory.java b/src/org/jivesoftware/smackx/commands/LocalCommandFactory.java new file mode 100644 index 0000000..83fc455 --- /dev/null +++ b/src/org/jivesoftware/smackx/commands/LocalCommandFactory.java @@ -0,0 +1,43 @@ +/** + * $RCSfile$ + * $Revision$ + * $Date$ + * + * Copyright 2008 Jive Software. + * + * All rights reserved. Licensed 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.jivesoftware.smackx.commands; + +/** + * A factory for creating local commands. It's useful in cases where instantiation + * of a command is more complicated than just using the default constructor. For example, + * when arguments must be passed into the constructor or when using a dependency injection + * framework. When a LocalCommandFactory isn't used, you can provide the AdHocCommandManager + * a Class object instead. For more details, see + * {@link AdHocCommandManager#registerCommand(String, String, LocalCommandFactory)}. + * + * @author Matt Tucker + */ +public interface LocalCommandFactory { + + /** + * Returns an instance of a LocalCommand. + * + * @return a LocalCommand instance. + * @throws InstantiationException if creating an instance failed. + * @throws IllegalAccessException if creating an instance is not allowed. + */ + public LocalCommand getInstance() throws InstantiationException, IllegalAccessException; + +}
\ No newline at end of file |