Document TabFile, GroupList, QueryList

Change-Id: Iaed2eaa5ac501eeb6f8cbda7d1352cec1260a84e
This commit is contained in:
Han-Wen Nienhuys
2019-12-12 16:54:48 +01:00
parent 9a07681dc2
commit 918e4e5bde
3 changed files with 13 additions and 1 deletions

View File

@@ -28,7 +28,12 @@ import java.util.List;
import org.eclipse.jgit.errors.ConfigInvalidException;
import org.eclipse.jgit.lib.CommitBuilder;
/** Named Queries for user accounts. */
/**
* Named Queries for user accounts.
*
* <p>Users can define aliases for change queries. These are stored as versioned account data and
* (de)serialized with this class.
*/
public class VersionedAccountQueries extends VersionedMetaData {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();

View File

@@ -27,6 +27,7 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
/** (De)serializer for tab-delimited text files. */
public class TabFile {
@FunctionalInterface
public interface Parser {

View File

@@ -28,6 +28,12 @@ import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* File format for group name aliases.
*
* <p>Project configuration must use aliases for groups used in the permission section. The
* aliases/group mapping is stored in a file "groups", (de)serialized with this class.
*/
public class GroupList extends TabFile {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();