Summary: At each call to `Component$Builder.build()`, checks that the required props for `Component` have been set via prior calls to the `Builder`. Does not yet handle `Prop(optional = true)`, but will address that in a follow-up. Reviewed By: jeremydubreil Differential Revision: D6735524 fbshipit-source-id: 0c812fdmaster
Sam Blackshear
7 years ago
committed by
Facebook Github Bot
parent
c98bc53ede
commit
4545f36875
@ -0,0 +1,16 @@
|
||||
/*
|
||||
* Copyright (c) 2018 - present Facebook, Inc.
|
||||
* All rights reserved.
|
||||
*
|
||||
* This source code is licensed under the BSD style license found in the
|
||||
* LICENSE file in the root directory of this source tree. An additional grant
|
||||
* of patent rights can be found in the PATENTS file in the same directory.
|
||||
*/
|
||||
package com.facebook.litho;
|
||||
|
||||
public class Component {
|
||||
|
||||
public abstract static class Builder {
|
||||
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,179 @@
|
||||
/*
|
||||
* Copyright (c) 2018 - present Facebook, Inc.
|
||||
* All rights reserved.
|
||||
*
|
||||
* This source code is licensed under the BSD style license found in the
|
||||
* LICENSE file in the root directory of this source tree. An additional grant
|
||||
* of patent rights can be found in the PATENTS file in the same directory.
|
||||
*/
|
||||
import com.facebook.litho.Component;
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
enum ResType {
|
||||
SOME,
|
||||
NONE
|
||||
}
|
||||
|
||||
@Target({ ElementType.PARAMETER, ElementType.FIELD })
|
||||
@Retention(RetentionPolicy.CLASS)
|
||||
@interface Prop {
|
||||
ResType resType();
|
||||
boolean optional() default false;
|
||||
}
|
||||
|
||||
class MyComponent extends Component {
|
||||
@Prop(resType = ResType.NONE, optional = false)
|
||||
Object prop1;
|
||||
|
||||
@Prop(resType = ResType.NONE, optional = true)
|
||||
Object prop2;
|
||||
|
||||
@Prop(resType = ResType.SOME, optional = false)
|
||||
Object prop3;
|
||||
|
||||
Object nonProp;
|
||||
|
||||
public Builder create() {
|
||||
return new Builder();
|
||||
}
|
||||
|
||||
static class Builder extends Component.Builder {
|
||||
MyComponent mMyComponent;
|
||||
|
||||
public Builder prop1(Object o) {
|
||||
this.mMyComponent.prop1 = o;
|
||||
return this;
|
||||
}
|
||||
|
||||
public Builder prop2(Object o) {
|
||||
this.mMyComponent.prop2 = o;
|
||||
return this;
|
||||
}
|
||||
|
||||
public Builder prop3(Object o) {
|
||||
this.mMyComponent.prop3 = o;
|
||||
return this;
|
||||
}
|
||||
|
||||
public MyComponent build() {
|
||||
return mMyComponent;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public class RequiredProps {
|
||||
|
||||
public MyComponent mMyComponent;
|
||||
|
||||
public MyComponent buildWithAllOk() {
|
||||
return
|
||||
mMyComponent
|
||||
.create()
|
||||
.prop1(new Object())
|
||||
.prop2(new Object())
|
||||
.prop3(new Object())
|
||||
.build();
|
||||
}
|
||||
|
||||
// need to parse optional boolean for this to work
|
||||
public MyComponent FP_buildWithRequiredOk() {
|
||||
return
|
||||
mMyComponent
|
||||
.create()
|
||||
.prop1(new Object())
|
||||
.prop3(new Object())
|
||||
.build();
|
||||
}
|
||||
|
||||
public MyComponent buildWithout1Bad() {
|
||||
return
|
||||
mMyComponent
|
||||
.create()
|
||||
.prop2(new Object())
|
||||
.prop3(new Object())
|
||||
.build();
|
||||
}
|
||||
|
||||
public MyComponent buildWithout2Bad() {
|
||||
return
|
||||
mMyComponent
|
||||
.create()
|
||||
.prop1(new Object())
|
||||
.prop3(new Object())
|
||||
.build();
|
||||
}
|
||||
|
||||
private static MyComponent.Builder setProp1(MyComponent.Builder builder) {
|
||||
return builder.prop1(new Object());
|
||||
}
|
||||
|
||||
private static MyComponent.Builder setProp3(MyComponent.Builder builder) {
|
||||
return builder.prop3(new Object());
|
||||
}
|
||||
|
||||
public MyComponent setProp1InCalleeOk() {
|
||||
return
|
||||
setProp1(
|
||||
mMyComponent
|
||||
.create()
|
||||
.prop2(new Object()))
|
||||
.prop3(new Object())
|
||||
.build();
|
||||
}
|
||||
|
||||
public MyComponent setProp3InCalleeOk() {
|
||||
return
|
||||
setProp3(
|
||||
mMyComponent
|
||||
.create()
|
||||
.prop1(new Object())
|
||||
.prop2(new Object()))
|
||||
.build();
|
||||
}
|
||||
|
||||
public MyComponent setProp3InCalleeButForgetProp1Bad() {
|
||||
return
|
||||
setProp3(mMyComponent.create())
|
||||
.prop2(new Object())
|
||||
.build();
|
||||
}
|
||||
|
||||
public MyComponent setRequiredOnOneBranchBad(boolean b) {
|
||||
MyComponent.Builder builder = mMyComponent.create();
|
||||
if (b) {
|
||||
builder = builder.prop1(new Object());
|
||||
}
|
||||
return builder.prop2(new Object()).prop3(new Object()).build();
|
||||
}
|
||||
|
||||
public MyComponent FP_setRequiredOnBothBranchesOk(boolean b) {
|
||||
MyComponent.Builder builder = mMyComponent.create();
|
||||
if (b) {
|
||||
builder = builder.prop1(new Object());
|
||||
} else {
|
||||
builder = builder.prop1(new Object());
|
||||
}
|
||||
return builder.prop2(new Object()).prop3(new Object()).build();
|
||||
}
|
||||
|
||||
// we report every time we see [build()], need to be a bit smarter in general
|
||||
private MyComponent FP_buildSuffix(MyComponent.Builder builder) {
|
||||
return builder.prop2(new Object()).prop3(new Object()).build();
|
||||
}
|
||||
|
||||
// shouldn't report here
|
||||
public MyComponent callBuildSuffixWithRequiredOk() {
|
||||
return FP_buildSuffix(mMyComponent.create().prop1(new Object()));
|
||||
}
|
||||
|
||||
// should report here
|
||||
public MyComponent FN_callBuildSuffixWithoutRequiredBad() {
|
||||
return FP_buildSuffix(mMyComponent.create());
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in new issue