Companion.java

/*
   Copyright 2016 Immutables Authors and Contributors

   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.immutables.fixture.modifiable;

import com.atlassian.fugue.Option;
import com.google.common.base.Optional;
import com.google.common.collect.*;
import org.immutables.value.Value;

import javax.annotation.Nullable;
import java.lang.annotation.RetentionPolicy;
import java.util.*;

@Value.Immutable
@Value.Modifiable
public interface Companion {
  int integer();

  String string();

  @Nullable
  Boolean bools();

  List<String> str();

  Set<Integer> ints();

  int[] arrayInts();

  String[] arrayStrings();

  @Value.NaturalOrder
  SortedSet<Integer> ords();

  Set<RetentionPolicy> pols();

  @Value.ReverseOrder
  NavigableSet<Integer> navs();

  Map<Long, Integer> just();

  @Value.NaturalOrder
  SortedMap<Integer, String> ordsmap();

  Map<RetentionPolicy, Integer> polsmap();

  @Value.ReverseOrder
  NavigableMap<String, Integer> navsmap();

  @Value.Modifiable
  @Value.Style(create = "new")
  interface Small {
    @Value.Parameter
    int first();

    @Value.Parameter
    String second();
  }

  @Value.Modifiable
  interface Standalone {
    @Value.Parameter
    int first();

    @Value.Parameter
    String second();

    @Value.Parameter
    short sh();

    @Value.Parameter
    char ch();

    @Value.Parameter
    boolean bool();

    @Value.Parameter
    double dob();

    @Value.Parameter
    float fl();

    Optional<Integer> v1();

    java.util.Optional<Integer> v2();

    OptionalInt i1();

    OptionalLong l1();

    OptionalDouble d1();

    Option<Integer> fugue2();

    io.atlassian.fugue.Option<Integer> fugue3();

    @Value.Default
    default int def() {
      return 1;
    }

    @Value.Default
    default String defs() {
      return "";
    }

    @Value.Lazy
    default String lazy() {
      return "";
    }

    @Value.Derived
    default int derived() {
      return v1().or(0);
    }

    @Nullable
    List<Unit> nullableUnit();
  }

  @Value.Style(strictBuilder = true)
  @Value.Modifiable
  interface Extra {
    @Value.Parameter
    Multiset<String> bag();

    @Value.Parameter
    Multimap<Integer, String> index();

    @Value.Parameter
    ListMultimap<Integer, String> indexList();

    @Value.Parameter
    SetMultimap<Integer, String> indexSet();

    @Value.Parameter
    BiMap<Integer, String> biMap();
  }

  @Value.Modifiable
  @Value.Immutable
  @Value.Style(jdkOnly = true)
  interface JdkComp {
    int integer();

    String string();

    @Nullable
    Boolean bools();

    List<String> str();

    Set<Integer> ints();

    int[] arrayInts();

    String[] arrayStrings();

    @Value.NaturalOrder
    SortedSet<Integer> ords();

    Set<RetentionPolicy> pols();

    @Value.ReverseOrder
    NavigableSet<Integer> navs();
  }

  @Value.Style(deferCollectionAllocation = true)
  @Value.Modifiable
  @Value.Immutable
  interface NullableAndDefault {
    List<String> lst();

    @Value.Default
    @Nullable
    default List<String> str() {
      return null;
    }

    @Value.Default
    default Set<Integer> ints() {
      return Collections.singleton(1);
    }

    @Value.Default
    default int[] arrayInts() {
      return new int[0];
    }

    @Value.NaturalOrder
    @Nullable
    @Value.Default
    default SortedSet<Integer> ords() {
      return null;
    }

    @Value.Default
    default Set<RetentionPolicy> pols() {
      return EnumSet.noneOf(RetentionPolicy.class);
    }

    @Value.Default
    @Value.ReverseOrder
    default NavigableSet<Integer> navs() {
      return Collections.emptyNavigableSet();
    }
  }
}