Clearly mark java CSSNode as deprecated. It will go away very soon

Summary: Clearly mark java CSSNode as deprecated. It will go away very soon.

Reviewed By: lucasr

Differential Revision: D3992775

fbshipit-source-id: b3ceca277e5c7426eb51f8cbeacf5e2fe451c6ec
This commit is contained in:
Emil Sjolander
2016-10-12 02:49:37 -07:00
committed by Facebook Github Bot
parent 871a7cf310
commit 62dba4c741
9 changed files with 88 additions and 88 deletions

View File

@@ -12,7 +12,7 @@ package com.facebook.csslayout;
import java.util.Arrays;
/**
* Where the output of {@link LayoutEngine#layoutNode(CSSNode, float)} will go in the CSSNode.
* Where the output of {@link LayoutEngine#layoutNode(CSSNodeDEPRECATED, float)} will go in the CSSNodeDEPRECATED.
*/
public class CSSLayout {
// This value was chosen based on empiracle data. Even the most complicated

View File

@@ -13,7 +13,7 @@ package com.facebook.csslayout;
* A context for holding values local to a given instance of layout computation.
*
* This is necessary for making layout thread-safe. A separate instance should
* be used when {@link CSSNode#calculateLayout} is called concurrently on
* be used when {@link CSSNodeDEPRECATED#calculateLayout} is called concurrently on
* different node hierarchies.
*/
public class CSSLayoutContext {

View File

@@ -24,7 +24,7 @@ import static com.facebook.csslayout.CSSLayout.POSITION_TOP;
* A CSS Node. It has a style object you can manipulate at {@link #style}. After calling
* {@link #calculateLayout()}, {@link #layout} will be filled with the results of the layout.
*/
public class CSSNode implements CSSNodeAPI<CSSNode> {
public class CSSNodeDEPRECATED implements CSSNodeAPI<CSSNodeDEPRECATED> {
private enum LayoutState {
/**
@@ -52,10 +52,10 @@ public class CSSNode implements CSSNodeAPI<CSSNode> {
public int lineIndex = 0;
CSSNode nextChild;
CSSNodeDEPRECATED nextChild;
private @Nullable ArrayList<CSSNode> mChildren;
private @Nullable CSSNode mParent;
private @Nullable ArrayList<CSSNodeDEPRECATED> mChildren;
private @Nullable CSSNodeDEPRECATED mParent;
private @Nullable MeasureFunction mMeasureFunction = null;
private LayoutState mLayoutState = LayoutState.DIRTY;
private boolean mIsTextNode = false;
@@ -72,13 +72,13 @@ public class CSSNode implements CSSNodeAPI<CSSNode> {
}
@Override
public CSSNode getChildAt(int i) {
public CSSNodeDEPRECATED getChildAt(int i) {
Assertions.assertNotNull(mChildren);
return mChildren.get(i);
}
@Override
public void addChildAt(CSSNode child, int i) {
public void addChildAt(CSSNodeDEPRECATED child, int i) {
if (child.mParent != null) {
throw new IllegalStateException("Child already has a parent, it must be removed first.");
}
@@ -93,16 +93,17 @@ public class CSSNode implements CSSNodeAPI<CSSNode> {
}
@Override
public CSSNode removeChildAt(int i) {
public CSSNodeDEPRECATED removeChildAt(int i) {
Assertions.assertNotNull(mChildren);
CSSNode removed = mChildren.remove(i);
CSSNodeDEPRECATED removed = mChildren.remove(i);
removed.mParent = null;
dirty();
return removed;
}
@Override
public @Nullable CSSNode getParent() {
public @Nullable
CSSNodeDEPRECATED getParent() {
return mParent;
}
@@ -110,7 +111,7 @@ public class CSSNode implements CSSNodeAPI<CSSNode> {
* @return the index of the given child, or -1 if the child doesn't exist in this node.
*/
@Override
public int indexOf(CSSNode child) {
public int indexOf(CSSNodeDEPRECATED child) {
Assertions.assertNotNull(mChildren);
return mChildren.indexOf(child);
}
@@ -427,7 +428,6 @@ public class CSSNode implements CSSNodeAPI<CSSNode> {
}
}
/**
* Get this node's margin, as defined by style + default margin.
*/
@@ -637,12 +637,12 @@ public class CSSNode implements CSSNodeAPI<CSSNode> {
/**
* Resets this instance to its default state. This method is meant to be used when
* recycling {@link CSSNode} instances.
* recycling {@link CSSNodeDEPRECATED} instances.
*/
@Override
public void reset() {
if (mParent != null || (mChildren != null && mChildren.size() > 0)) {
throw new IllegalStateException("You should not reset an attached CSSNode");
throw new IllegalStateException("You should not reset an attached CSSNodeDEPRECATED");
}
style.reset();

View File

@@ -12,7 +12,7 @@ package com.facebook.csslayout;
import java.util.Arrays;
/**
* The CSS style definition for a {@link CSSNode}.
* The CSS style definition for a {@link CSSNodeDEPRECATED}.
*/
public class CSSStyle {

View File

@@ -19,7 +19,7 @@ import static com.facebook.csslayout.CSSLayout.POSITION_RIGHT;
import static com.facebook.csslayout.CSSLayout.POSITION_TOP;
/**
* Calculates layouts based on CSS style. See {@link #layoutNode(CSSNode, float, float)}.
* Calculates layouts based on CSS style. See {@link #layoutNode(CSSNodeDEPRECATED, float, float)}.
*/
public class LayoutEngine {
@@ -77,20 +77,20 @@ public class LayoutEngine {
Spacing.END
};
private static boolean isFlexBasisAuto(CSSNode node) {
private static boolean isFlexBasisAuto(CSSNodeDEPRECATED node) {
return CSSConstants.isUndefined(node.style.flexBasis);
}
private static float getFlexGrowFactor(CSSNode node) {
private static float getFlexGrowFactor(CSSNodeDEPRECATED node) {
return node.style.flexGrow;
}
private static float getFlexShrinkFactor(CSSNode node) {
private static float getFlexShrinkFactor(CSSNodeDEPRECATED node) {
return node.style.flexShrink;
}
private static float boundAxisWithinMinAndMax(CSSNode node, int axis, float value) {
private static float boundAxisWithinMinAndMax(CSSNodeDEPRECATED node, int axis, float value) {
float min = CSSConstants.UNDEFINED;
float max = CSSConstants.UNDEFINED;
@@ -116,7 +116,7 @@ public class LayoutEngine {
return boundValue;
}
private static float boundAxis(CSSNode node, int axis, float value) {
private static float boundAxis(CSSNodeDEPRECATED node, int axis, float value) {
float paddingAndBorderAxis =
node.style.padding.getWithFallback(leadingSpacing[axis], leading[axis]) +
node.style.border.getWithFallback(leadingSpacing[axis], leading[axis]) +
@@ -125,7 +125,7 @@ public class LayoutEngine {
return Math.max(boundAxisWithinMinAndMax(node, axis, value), paddingAndBorderAxis);
}
private static float getRelativePosition(CSSNode node, int axis) {
private static float getRelativePosition(CSSNodeDEPRECATED node, int axis) {
float lead = node.style.position.getWithFallback(leadingSpacing[axis], leading[axis]);
if (!Float.isNaN(lead)) {
return lead;
@@ -135,7 +135,7 @@ public class LayoutEngine {
return Float.isNaN(trailingPos) ? 0 : -trailingPos;
}
private static void setPosition(CSSNode node, CSSDirection direction) {
private static void setPosition(CSSNodeDEPRECATED node, CSSDirection direction) {
int mainAxis = resolveAxis(getFlexDirection(node), direction);
int crossAxis = getCrossFlexDirection(mainAxis, direction);
@@ -163,7 +163,7 @@ public class LayoutEngine {
return axis;
}
private static CSSDirection resolveDirection(CSSNode node, CSSDirection parentDirection) {
private static CSSDirection resolveDirection(CSSNodeDEPRECATED node, CSSDirection parentDirection) {
CSSDirection direction = node.style.direction;
if (direction == CSSDirection.INHERIT) {
direction = (parentDirection == null ? CSSDirection.LTR : parentDirection);
@@ -172,7 +172,7 @@ public class LayoutEngine {
return direction;
}
private static int getFlexDirection(CSSNode node) {
private static int getFlexDirection(CSSNodeDEPRECATED node) {
return node.style.flexDirection.ordinal();
}
@@ -187,20 +187,20 @@ public class LayoutEngine {
}
}
private static CSSAlign getAlignItem(CSSNode node, CSSNode child) {
private static CSSAlign getAlignItem(CSSNodeDEPRECATED node, CSSNodeDEPRECATED child) {
if (child.style.alignSelf != CSSAlign.AUTO) {
return child.style.alignSelf;
}
return node.style.alignItems;
}
private static boolean isMeasureDefined(CSSNode node) {
private static boolean isMeasureDefined(CSSNodeDEPRECATED node) {
return node.isMeasureDefined();
}
/*package*/ static void layoutNode(
CSSLayoutContext layoutContext,
CSSNode node,
CSSNodeDEPRECATED node,
float availableWidth,
float availableHeight,
CSSDirection parentDirection) {
@@ -326,7 +326,7 @@ public class LayoutEngine {
//
private static boolean layoutNodeInternal(
CSSLayoutContext layoutContext,
CSSNode node,
CSSNodeDEPRECATED node,
float availableWidth,
float availableHeight,
CSSDirection parentDirection,
@@ -522,7 +522,7 @@ public class LayoutEngine {
//
private static void layoutNodeImpl(
CSSLayoutContext layoutContext,
CSSNode node,
CSSNodeDEPRECATED node,
float availableWidth,
float availableHeight,
CSSDirection parentDirection,
@@ -636,8 +636,8 @@ public class LayoutEngine {
CSSJustify justifyContent = node.style.justifyContent;
boolean isNodeFlexWrap = (node.style.flexWrap == CSSWrap.WRAP);
CSSNode firstAbsoluteChild = null;
CSSNode currentAbsoluteChild = null;
CSSNodeDEPRECATED firstAbsoluteChild = null;
CSSNodeDEPRECATED currentAbsoluteChild = null;
float leadingPaddingAndBorderMain = (node.style.padding.getWithFallback(leadingSpacing[mainAxis], leading[mainAxis]) + node.style.border.getWithFallback(leadingSpacing[mainAxis], leading[mainAxis]));
float trailingPaddingAndBorderMain = (node.style.padding.getWithFallback(trailingSpacing[mainAxis], trailing[mainAxis]) + node.style.border.getWithFallback(trailingSpacing[mainAxis], trailing[mainAxis]));
@@ -655,7 +655,7 @@ public class LayoutEngine {
float availableInnerCrossDim = isMainAxisRow ? availableInnerHeight : availableInnerWidth;
// STEP 3: DETERMINE FLEX BASIS FOR EACH ITEM
CSSNode child;
CSSNodeDEPRECATED child;
int i;
float childWidth;
float childHeight;
@@ -791,8 +791,8 @@ public class LayoutEngine {
i = startOfLineIndex;
// Maintain a linked list of the child nodes that can shrink and/or grow.
CSSNode firstRelativeChild = null;
CSSNode currentRelativeChild = null;
CSSNodeDEPRECATED firstRelativeChild = null;
CSSNodeDEPRECATED currentRelativeChild = null;
// Add items to the current line until it's full or we run out of items.
while (i < childCount) {

View File

@@ -17,19 +17,19 @@ public class CSSLayoutFlexBasisTest {
@Test
public void testFlexBasis() {
final CSSNode root = new CSSNode();
final CSSNodeDEPRECATED root = new CSSNodeDEPRECATED();
root.setFlexDirection(CSSFlexDirection.ROW);
root.setStyleWidth(300);
root.setStyleHeight(100);
final CSSNode root_child0 = new CSSNode();
final CSSNodeDEPRECATED root_child0 = new CSSNodeDEPRECATED();
root_child0.setFlexGrow(1);
root_child0.setFlexBasis(100);
root_child0.setStyleWidth(200);
root_child0.setStyleHeight(100);
root.addChildAt(root_child0, 0);
final CSSNode root_child1 = new CSSNode();
final CSSNodeDEPRECATED root_child1 = new CSSNodeDEPRECATED();
root_child1.setFlexGrow(1);
root_child1.setStyleWidth(100);
root_child1.setStyleHeight(100);

View File

@@ -15,14 +15,14 @@ import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
/**
* Tests for {@link CSSNode}.
* Tests for {@link CSSNodeDEPRECATED}.
*/
public class CSSNodeTest {
@Test
public void testAddChildGetParent() {
CSSNode parent = new CSSNode();
CSSNode child = new CSSNode();
CSSNodeDEPRECATED parent = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED child = new CSSNodeDEPRECATED();
assertNull(child.getParent());
assertEquals(0, parent.getChildCount());
@@ -41,9 +41,9 @@ public class CSSNodeTest {
@Test(expected = IllegalStateException.class)
public void testCannotAddChildToMultipleParents() {
CSSNode parent1 = new CSSNode();
CSSNode parent2 = new CSSNode();
CSSNode child = new CSSNode();
CSSNodeDEPRECATED parent1 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED parent2 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED child = new CSSNodeDEPRECATED();
parent1.addChildAt(child, 0);
parent2.addChildAt(child, 0);

View File

@@ -14,12 +14,12 @@ import org.junit.Test;
import static junit.framework.Assert.*;
/**
* Tests for {@link LayoutEngine} and {@link CSSNode} to make sure layouts are only generated when
* Tests for {@link LayoutEngine} and {@link CSSNodeDEPRECATED} to make sure layouts are only generated when
* needed.
*/
public class LayoutCachingTest {
private void assertTreeHasNewLayout(boolean expectedHasNewLayout, CSSNode root) {
private void assertTreeHasNewLayout(boolean expectedHasNewLayout, CSSNodeDEPRECATED root) {
assertEquals(expectedHasNewLayout, root.hasNewLayout());
for (int i = 0; i < root.getChildCount(); i++) {
@@ -27,7 +27,7 @@ public class LayoutCachingTest {
}
}
private void markLayoutAppliedForTree(CSSNode root) {
private void markLayoutAppliedForTree(CSSNodeDEPRECATED root) {
root.markLayoutSeen();
for (int i = 0; i < root.getChildCount(); i++) {
markLayoutAppliedForTree(root.getChildAt(i));
@@ -37,10 +37,10 @@ public class LayoutCachingTest {
@Test
public void testCachesFullTree() {
CSSLayoutContext layoutContext = new CSSLayoutContext();
CSSNode root = new CSSNode();
CSSNode c0 = new CSSNode();
CSSNode c1 = new CSSNode();
CSSNode c0c0 = new CSSNode();
CSSNodeDEPRECATED root = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0c0 = new CSSNodeDEPRECATED();
root.addChildAt(c0, 0);
root.addChildAt(c1, 1);
c0.addChildAt(c0c0, 0);
@@ -58,12 +58,12 @@ public class LayoutCachingTest {
@Test
public void testInvalidatesCacheWhenChildAdded() {
CSSLayoutContext layoutContext = new CSSLayoutContext();
CSSNode root = new CSSNode();
CSSNode c0 = new CSSNode();
CSSNode c1 = new CSSNode();
CSSNode c0c0 = new CSSNode();
CSSNode c0c1 = new CSSNode();
CSSNode c1c0 = new CSSNode();
CSSNodeDEPRECATED root = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0c0 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0c1 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1c0 = new CSSNodeDEPRECATED();
c0c1.setStyleWidth(200);
c0c1.setStyleHeight(200);
root.addChildAt(c0, 0);
@@ -90,10 +90,10 @@ public class LayoutCachingTest {
@Test
public void testInvalidatesCacheWhenEnumPropertyChanges() {
CSSLayoutContext layoutContext = new CSSLayoutContext();
CSSNode root = new CSSNode();
CSSNode c0 = new CSSNode();
CSSNode c1 = new CSSNode();
CSSNode c0c0 = new CSSNode();
CSSNodeDEPRECATED root = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0c0 = new CSSNodeDEPRECATED();
root.addChildAt(c0, 0);
root.addChildAt(c1, 1);
c0.addChildAt(c0c0, 0);
@@ -114,10 +114,10 @@ public class LayoutCachingTest {
@Test
public void testInvalidatesCacheWhenFloatPropertyChanges() {
CSSLayoutContext layoutContext = new CSSLayoutContext();
CSSNode root = new CSSNode();
CSSNode c0 = new CSSNode();
CSSNode c1 = new CSSNode();
CSSNode c0c0 = new CSSNode();
CSSNodeDEPRECATED root = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0c0 = new CSSNodeDEPRECATED();
root.addChildAt(c0, 0);
root.addChildAt(c1, 1);
c0.addChildAt(c0c0, 0);
@@ -138,11 +138,11 @@ public class LayoutCachingTest {
@Test
public void testInvalidatesFullTreeWhenParentWidthChanges() {
CSSLayoutContext layoutContext = new CSSLayoutContext();
CSSNode root = new CSSNode();
CSSNode c0 = new CSSNode();
CSSNode c1 = new CSSNode();
CSSNode c0c0 = new CSSNode();
CSSNode c1c0 = new CSSNode();
CSSNodeDEPRECATED root = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0c0 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1c0 = new CSSNodeDEPRECATED();
root.addChildAt(c0, 0);
root.addChildAt(c1, 1);
c0.addChildAt(c0c0, 0);
@@ -165,10 +165,10 @@ public class LayoutCachingTest {
@Test
public void testDoesNotInvalidateCacheWhenPropertyIsTheSame() {
CSSLayoutContext layoutContext = new CSSLayoutContext();
CSSNode root = new CSSNode();
CSSNode c0 = new CSSNode();
CSSNode c1 = new CSSNode();
CSSNode c0c0 = new CSSNode();
CSSNodeDEPRECATED root = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0c0 = new CSSNodeDEPRECATED();
root.addChildAt(c0, 0);
root.addChildAt(c1, 1);
c0.addChildAt(c0c0, 0);
@@ -188,10 +188,10 @@ public class LayoutCachingTest {
@Test
public void testInvalidateCacheWhenHeightChangesPosition() {
CSSLayoutContext layoutContext = new CSSLayoutContext();
CSSNode root = new CSSNode();
CSSNode c0 = new CSSNode();
CSSNode c1 = new CSSNode();
CSSNode c1c0 = new CSSNode();
CSSNodeDEPRECATED root = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1c0 = new CSSNodeDEPRECATED();
root.addChildAt(c0, 0);
root.addChildAt(c1, 1);
c1.addChildAt(c1c0, 0);
@@ -211,10 +211,10 @@ public class LayoutCachingTest {
@Test
public void testInvalidatesOnNewMeasureFunction() {
CSSLayoutContext layoutContext = new CSSLayoutContext();
CSSNode root = new CSSNode();
CSSNode c0 = new CSSNode();
CSSNode c1 = new CSSNode();
CSSNode c0c0 = new CSSNode();
CSSNodeDEPRECATED root = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c1 = new CSSNodeDEPRECATED();
CSSNodeDEPRECATED c0c0 = new CSSNodeDEPRECATED();
root.addChildAt(c0, 0);
root.addChildAt(c1, 1);
c0.addChildAt(c0c0, 0);

View File

@@ -23,7 +23,7 @@ import static com.facebook.csslayout.CSSLayout.DIMENSION_HEIGHT;
public class LayoutEngineTest {
private static final CSSNodeAPI.MeasureFunction sTestMeasureFunction =
new CSSNode.MeasureFunction() {
new CSSNodeDEPRECATED.MeasureFunction() {
@Override
public void measure(CSSNodeAPI node, float width, CSSMeasureMode widthMode, float height, CSSMeasureMode heightMode, MeasureOutput measureOutput) {
@@ -72,7 +72,7 @@ public class LayoutEngineTest {
}
};
private static class TestCSSNode extends CSSNode {
private static class TestCSSNode extends CSSNodeDEPRECATED {
public String context = null;
@@ -81,7 +81,7 @@ public class LayoutEngineTest {
}
}
private static void test(String message, CSSNode style, CSSNode expectedLayout) {
private static void test(String message, CSSNodeDEPRECATED style, CSSNodeDEPRECATED expectedLayout) {
CSSLayoutContext layoutContext = new CSSLayoutContext();
style.calculateLayout(layoutContext);
assertLayoutsEqual(message, style, expectedLayout);
@@ -93,13 +93,13 @@ public class LayoutEngineTest {
}
}
private static void assertLayoutsEqual(String message, CSSNode actual, CSSNode expected) {
private static void assertLayoutsEqual(String message, CSSNodeDEPRECATED actual, CSSNodeDEPRECATED expected) {
Assert.assertTrue(
message + "\nActual:\n" + actual.toString() + "\nExpected:\n" + expected.toString(),
areLayoutsEqual(actual, expected));
}
private static boolean areLayoutsEqual(CSSNode a, CSSNode b) {
private static boolean areLayoutsEqual(CSSNodeDEPRECATED a, CSSNodeDEPRECATED b) {
boolean doNodesHaveSameLayout =
areFloatsEqual(a.layout.position[POSITION_LEFT], b.layout.position[POSITION_LEFT]) &&
areFloatsEqual(a.layout.position[POSITION_TOP], b.layout.position[POSITION_TOP]) &&