Java tutorial
/** * Copyright (C) 2013 - present by OpenGamma Inc. and the OpenGamma group of companies * * Please see distribution for license. */ package com.opengamma.collect.result; import java.io.Serializable; import java.util.Map; import java.util.NoSuchElementException; import java.util.Set; import java.util.stream.Collectors; import org.joda.beans.Bean; import org.joda.beans.BeanBuilder; import org.joda.beans.BeanDefinition; import org.joda.beans.ImmutableBean; import org.joda.beans.JodaBeanUtils; import org.joda.beans.MetaProperty; import org.joda.beans.Property; import org.joda.beans.PropertyDefinition; import org.joda.beans.impl.direct.DirectFieldsBeanBuilder; import org.joda.beans.impl.direct.DirectMetaBean; import org.joda.beans.impl.direct.DirectMetaProperty; import org.joda.beans.impl.direct.DirectMetaPropertyMap; import com.google.common.base.Strings; import com.google.common.base.Throwables; import com.google.common.collect.ImmutableSet; import com.opengamma.collect.ArgChecker; /** * Description of a failed result. * <p> * If calculation of a result fails this class provides details of the failure. * There is a single reason and message and a set of detailed failure items. * Each {@link FailureItem} has details of the actual cause. * <p> * Instances of {@code Failure} are public classes created via {@link Result}. */ @BeanDefinition(builderScope = "private") public final class Failure implements ImmutableBean, Serializable { /** * The reason associated with the failure. */ @PropertyDefinition(validate = "notNull") private final FailureReason reason; /** * The error message associated with the failure. */ @PropertyDefinition(validate = "notEmpty") private final String message; /** * The set of failure items. * There will be at least one failure item. */ @PropertyDefinition(validate = "notEmpty") private final ImmutableSet<FailureItem> items; //------------------------------------------------------------------------- /** * Obtains a failure from a reason, message and exception. * * @param reason the reason * @param message the failure message * @param cause the cause * @return the failure */ static Failure of(FailureReason reason, String message, Exception cause) { ArgChecker.notNull(reason, "reason"); ArgChecker.notEmpty(message, "message"); ArgChecker.notNull(cause, "cause"); String stackTrace = Throwables.getStackTraceAsString(cause); return Failure.of(FailureItem.of(reason, message, stackTrace, cause.getClass())); } /** * Obtains a failure from a reason and message. * * @param reason the reason * @param message the failure message, not empty */ static Failure of(FailureReason reason, String message) { ArgChecker.notNull(reason, "reason"); ArgChecker.notEmpty(message, "message"); String stackTrace = getStackTraceAsString(new Exception()); return Failure.of(FailureItem.of(reason, message, stackTrace, null)); } /** * Obtains a failure from a reason and exception. * * @param reason the reason * @param cause the cause */ static Failure of(FailureReason reason, Exception cause) { ArgChecker.notNull(reason, "reason"); ArgChecker.notNull(cause, "cause"); String causeMessage = ArgChecker.notNull(cause, "cause").getMessage(); String message = Strings.isNullOrEmpty(causeMessage) ? cause.getClass().getSimpleName() : causeMessage; return Failure.of(reason, message, cause); } /** * Obtains a failure for a single failure item. * * @param item the failure item * @return the failure */ private static Failure of(FailureItem item) { return new Failure(item.getReason(), item.getMessage(), ImmutableSet.of(item)); } /** * Obtains a failure for a non-empty set of failure items. * * @param items the failures, not empty * @return the failure */ static Failure of(ImmutableSet<FailureItem> items) { ArgChecker.notEmpty(items, "items"); String message = items.stream().map(FailureItem::getMessage).collect(Collectors.joining(", ")); FailureReason reason = items.stream().map(FailureItem::getReason) .reduce((s1, s2) -> s1 == s2 ? s1 : FailureReason.MULTIPLE).get(); return new Failure(reason, message, items); } private static String getStackTraceAsString(Exception e) { StringBuilder builder = new StringBuilder(); StackTraceElement[] stackTrace = e.getStackTrace(); // drop the first 2 frames because they're always the Failure constructor and Result.failure for (int i = 2; i < stackTrace.length; i++) { builder.append("\tat ").append(stackTrace[i]).append("\n"); } return builder.toString(); } //------------------------- AUTOGENERATED START ------------------------- ///CLOVER:OFF /** * The meta-bean for {@code Failure}. * @return the meta-bean, not null */ public static Failure.Meta meta() { return Failure.Meta.INSTANCE; } static { JodaBeanUtils.registerMetaBean(Failure.Meta.INSTANCE); } /** * The serialization version id. */ private static final long serialVersionUID = 1L; private Failure(FailureReason reason, String message, Set<FailureItem> items) { JodaBeanUtils.notNull(reason, "reason"); JodaBeanUtils.notEmpty(message, "message"); JodaBeanUtils.notEmpty(items, "items"); this.reason = reason; this.message = message; this.items = ImmutableSet.copyOf(items); } @Override public Failure.Meta metaBean() { return Failure.Meta.INSTANCE; } @Override public <R> Property<R> property(String propertyName) { return metaBean().<R>metaProperty(propertyName).createProperty(this); } @Override public Set<String> propertyNames() { return metaBean().metaPropertyMap().keySet(); } //----------------------------------------------------------------------- /** * Gets the reason associated with the failure. * @return the value of the property, not null */ public FailureReason getReason() { return reason; } //----------------------------------------------------------------------- /** * Gets the error message associated with the failure. * @return the value of the property, not empty */ public String getMessage() { return message; } //----------------------------------------------------------------------- /** * Gets the set of failure items. * There will be at least one failure item. * @return the value of the property, not empty */ public ImmutableSet<FailureItem> getItems() { return items; } //----------------------------------------------------------------------- @Override public boolean equals(Object obj) { if (obj == this) { return true; } if (obj != null && obj.getClass() == this.getClass()) { Failure other = (Failure) obj; return JodaBeanUtils.equal(getReason(), other.getReason()) && JodaBeanUtils.equal(getMessage(), other.getMessage()) && JodaBeanUtils.equal(getItems(), other.getItems()); } return false; } @Override public int hashCode() { int hash = getClass().hashCode(); hash = hash * 31 + JodaBeanUtils.hashCode(getReason()); hash = hash * 31 + JodaBeanUtils.hashCode(getMessage()); hash = hash * 31 + JodaBeanUtils.hashCode(getItems()); return hash; } @Override public String toString() { StringBuilder buf = new StringBuilder(128); buf.append("Failure{"); buf.append("reason").append('=').append(getReason()).append(',').append(' '); buf.append("message").append('=').append(getMessage()).append(',').append(' '); buf.append("items").append('=').append(JodaBeanUtils.toString(getItems())); buf.append('}'); return buf.toString(); } //----------------------------------------------------------------------- /** * The meta-bean for {@code Failure}. */ public static final class Meta extends DirectMetaBean { /** * The singleton instance of the meta-bean. */ static final Meta INSTANCE = new Meta(); /** * The meta-property for the {@code reason} property. */ private final MetaProperty<FailureReason> reason = DirectMetaProperty.ofImmutable(this, "reason", Failure.class, FailureReason.class); /** * The meta-property for the {@code message} property. */ private final MetaProperty<String> message = DirectMetaProperty.ofImmutable(this, "message", Failure.class, String.class); /** * The meta-property for the {@code items} property. */ @SuppressWarnings({ "unchecked", "rawtypes" }) private final MetaProperty<ImmutableSet<FailureItem>> items = DirectMetaProperty.ofImmutable(this, "items", Failure.class, (Class) ImmutableSet.class); /** * The meta-properties. */ private final Map<String, MetaProperty<?>> metaPropertyMap$ = new DirectMetaPropertyMap(this, null, "reason", "message", "items"); /** * Restricted constructor. */ private Meta() { } @Override protected MetaProperty<?> metaPropertyGet(String propertyName) { switch (propertyName.hashCode()) { case -934964668: // reason return reason; case 954925063: // message return message; case 100526016: // items return items; } return super.metaPropertyGet(propertyName); } @Override public BeanBuilder<? extends Failure> builder() { return new Failure.Builder(); } @Override public Class<? extends Failure> beanType() { return Failure.class; } @Override public Map<String, MetaProperty<?>> metaPropertyMap() { return metaPropertyMap$; } //----------------------------------------------------------------------- /** * The meta-property for the {@code reason} property. * @return the meta-property, not null */ public MetaProperty<FailureReason> reason() { return reason; } /** * The meta-property for the {@code message} property. * @return the meta-property, not null */ public MetaProperty<String> message() { return message; } /** * The meta-property for the {@code items} property. * @return the meta-property, not null */ public MetaProperty<ImmutableSet<FailureItem>> items() { return items; } //----------------------------------------------------------------------- @Override protected Object propertyGet(Bean bean, String propertyName, boolean quiet) { switch (propertyName.hashCode()) { case -934964668: // reason return ((Failure) bean).getReason(); case 954925063: // message return ((Failure) bean).getMessage(); case 100526016: // items return ((Failure) bean).getItems(); } return super.propertyGet(bean, propertyName, quiet); } @Override protected void propertySet(Bean bean, String propertyName, Object newValue, boolean quiet) { metaProperty(propertyName); if (quiet) { return; } throw new UnsupportedOperationException("Property cannot be written: " + propertyName); } } //----------------------------------------------------------------------- /** * The bean-builder for {@code Failure}. */ private static final class Builder extends DirectFieldsBeanBuilder<Failure> { private FailureReason reason; private String message; private Set<FailureItem> items = ImmutableSet.of(); /** * Restricted constructor. */ private Builder() { } //----------------------------------------------------------------------- @Override public Object get(String propertyName) { switch (propertyName.hashCode()) { case -934964668: // reason return reason; case 954925063: // message return message; case 100526016: // items return items; default: throw new NoSuchElementException("Unknown property: " + propertyName); } } @SuppressWarnings("unchecked") @Override public Builder set(String propertyName, Object newValue) { switch (propertyName.hashCode()) { case -934964668: // reason this.reason = (FailureReason) newValue; break; case 954925063: // message this.message = (String) newValue; break; case 100526016: // items this.items = (Set<FailureItem>) newValue; break; default: throw new NoSuchElementException("Unknown property: " + propertyName); } return this; } @Override public Builder set(MetaProperty<?> property, Object value) { super.set(property, value); return this; } @Override public Builder setString(String propertyName, String value) { setString(meta().metaProperty(propertyName), value); return this; } @Override public Builder setString(MetaProperty<?> property, String value) { super.setString(property, value); return this; } @Override public Builder setAll(Map<String, ? extends Object> propertyValueMap) { super.setAll(propertyValueMap); return this; } @Override public Failure build() { return new Failure(reason, message, items); } //----------------------------------------------------------------------- @Override public String toString() { StringBuilder buf = new StringBuilder(128); buf.append("Failure.Builder{"); buf.append("reason").append('=').append(JodaBeanUtils.toString(reason)).append(',').append(' '); buf.append("message").append('=').append(JodaBeanUtils.toString(message)).append(',').append(' '); buf.append("items").append('=').append(JodaBeanUtils.toString(items)); buf.append('}'); return buf.toString(); } } ///CLOVER:ON //-------------------------- AUTOGENERATED END -------------------------- }