Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #710 from csmith/config-iface
More interface/API work.
- Loading branch information
Showing
9 changed files
with
67 additions
and
47 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
/* | ||
* Copyright (c) 2006-2015 DMDirc Developers | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a copy | ||
* of this software and associated documentation files (the "Software"), to deal | ||
* in the Software without restriction, including without limitation the rights | ||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
* copies of the Software, and to permit persons to whom the Software is | ||
* furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in | ||
* all copies or substantial portions of the Software. | ||
* | ||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
* SOFTWARE. | ||
*/ | ||
|
||
package com.dmdirc.config; | ||
|
||
import javax.annotation.Nonnull; | ||
|
||
/** | ||
* Facilitates automatically binding fields or methods annotated with a {@link ConfigBinding} | ||
* element to a configuration value. | ||
*/ | ||
public interface ConfigBinder { | ||
|
||
/** | ||
* Binds all annotated methods and fields of the given instance to this binder's configuration | ||
* manager. | ||
* | ||
* @param instance The instance to be bound | ||
* @param clazz The class to read bindings from | ||
*/ | ||
void bind(final Object instance, final Class<?> clazz); | ||
|
||
/** | ||
* Unbinds all elements of the given instance that have been bound using this ConfigBinder. | ||
* | ||
* @param instance The instance to be unbound | ||
*/ | ||
void unbind(final Object instance); | ||
|
||
/** | ||
* Returns a new config binder with the specified default domain. | ||
* | ||
* @param domain The default domain to use if one is not specified | ||
* @return A config binder with the specified default domain. | ||
*/ | ||
ConfigBinder withDefaultDomain(@Nonnull final String domain); | ||
|
||
} |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters