io.resys.thena.docdb.api.models.Objects Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thena-docdb-api Show documentation
The newest version!
package io.resys.thena.docdb.api.models;

/*-
 * #%L
 * thena-docdb-api
 * %%
 * Copyright (C) 2021 Copyright 2021 ReSys OÜ
 * %%
 * 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.
 * #L%
 */

import java.time.LocalDateTime;
import java.util.Map;
import java.util.Optional;

import org.immutables.value.Value;

@Value.Immutable
public interface Objects {
  Map getRefs();
  Map getTags();
  Map getValues();
  
  interface IsObject { String getId(); }
  interface IsName { String getName(); }
  
  // branch with a name
  @Value.Immutable
  interface Ref extends IsName {
    // last commit in the branch
    String getCommit();
  }

  @Value.Immutable
  interface Tag extends IsName {
    // id of a commit
    String getCommit();
    LocalDateTime getDateTime();
    String getAuthor();
    String getMessage();
  }
  
  // World state 
  @Value.Immutable
  interface Tree extends IsObject {
    // resource name - blob id
    Map getValues();
  }
  
  // Resource name - blob id(content in blob)
  @Value.Immutable
  interface TreeValue {
    // Name of the resource
    String getName();
    // Id of the blob that holds content
    String getBlob();
  }
  
  @Value.Immutable
  interface Commit extends IsObject {
    String getAuthor();
    LocalDateTime getDateTime();
    String getMessage();
    
    // Parent commit id
    Optional getParent();
    
    // This commit is merge commit, that points to a commit in different branch
    Optional getMerge();
    
    // Tree id that describes list of (resource name - content) entries
    String getTree();
  }
  
  @Value.Immutable
  interface Blob extends IsObject {
    io.vertx.core.json.JsonObject getValue();
  }
}