Cycle Finder टूल

इस्तेमाल का तरीका

यहां एक आसान उदाहरण दिया गया है, जिसमें दो क्लास, फ़ू और बार के बीच साइकल को दिखाया गया है.

cat Foo.java
package mypkg;
public class Foo {
  Bar myBar;
}

cat Bar.java
package mypkg;
public class Bar {
  Foo myFoo;
}

cycle_finder Foo.java Bar.java
acceptAST: mypkg/Bar.java
acceptAST: mypkg/Foo.java

***** Found reference cycle *****
Bar -> (field myFoo with type Foo)
Foo -> (field myBar with type Bar)
----- Full Types -----
Lmypkg/Bar;
Lmypkg/Foo;

1 CYCLES FOUND.

आउटपुट में, आपको पहले पार्स की जा रही हर JavaScript फ़ाइल के लिए acceptAST दिखेगा. यह सिर्फ़ जानकारी देने वाली लॉगिंग है.

हर साइकल के लिए, दो सूचियां प्रिंट की जाएंगी. पहली सूची में साइकल का ब्यौरा होता है. रेफ़रंस ग्राफ़ में हर लाइन में एक किनारे होता है. किनारे के ब्यौरे में, ऑरिजिन का टाइप और उसके बाद यह ब्यौरा दिखेगा कि ऑरिजिन टाइप, टारगेट टाइप को कैसे रेफ़र कर सकता है.

Full Types के तहत मौजूद दूसरी सूची में, साइकल में मौजूद हर टाइप के लिए खास तरह की कुंजियां दिखती हैं. यह इसलिए काम का है, क्योंकि इससे हर टाइप का पूरा पैकेज मिलता है.

सूचियों को छिपाएं

साइकल के कुछ हिस्सों में सुधार की ज़रूरत नहीं होगी. ऐसा इसलिए हो सकता है कि साइकल में लंबे समय तक रहने वाले ऐसे ऑब्जेक्ट हों जिन्हें डील की ज़रूरत नहीं होती. इसके अलावा, यह टूल कुछ फ़ील्ड के टाइप के आधार पर सैद्धांतिक साइकल का पता लगा सकता है. हालांकि, यह साबित हो सकता है कि इसमें शामिल ऑब्जेक्ट कभी भी साइकल नहीं बनाएंगे. इन मामलों में, हम इन साइकल की रिपोर्ट न करने के लिए, सप्रेस-लिस्ट फ़ाइलों का इस्तेमाल कर सकते हैं.

यह टूल --suppress-list विकल्प का इस्तेमाल करके, निलंबित की गई सूची वाली फ़ाइलों को स्वीकार करता है. सीमित-सूची वाली फ़ाइलें, सामान्य टेक्स्ट वाली ऐसी फ़ाइलें होती हैं जिनमें एक लाइन की एंट्री होती है. निलंबित सूची में शामिल की जाने वाली एंट्री, नीचे दिए गए उदाहरण में दिखाए गए चार फ़ॉर्म में से कोई एक फ़ॉर्म ले सकती है. एक सही साइकल को दबाने से बचने के लिए, कम की गई सूची वाली एंट्री को ज़्यादा से ज़्यादा सटीक बनाने का सुझाव दिया जाता है. '#' वर्ण का इस्तेमाल करके टिप्पणियां जोड़ी जा सकती हैं.

# Specifies that "fieldA" in ClassA will not refer to any object that is a subtype of ClassB.
FIELD my.pkg.ClassA.fieldA my.pkg.ClassB

# Suppresses all cycles containing "fieldA" in ClassA.
FIELD my.pkg.ClassA.fieldA

# Suppresses all cycles containing any field of ClassA.
TYPE my.pkg.ClassA

# Suppress all cycles containing the Inner's outer reference to ClassA.
OUTER my.pkg.ClassA.Inner

# Suppress all cycles containing the outer reference from an anonymous class declared in myMethod.
OUTER my.pkg.ClassA.myMethod.$

# Suppresses all cycles containing any type in package "my.pkg".
NAMESPACE my.pkg