| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058250592506025061250622506325064250652506625067250682506925070250712507225073250742507525076250772507825079250802508125082250832508425085250862508725088250892509025091250922509325094250952509625097250982509925100251012510225103251042510525106251072510825109251102511125112251132511425115251162511725118251192512025121251222512325124251252512625127251282512925130251312513225133251342513525136251372513825139251402514125142251432514425145251462514725148251492515025151251522515325154251552515625157251582515925160251612516225163251642516525166251672516825169251702517125172251732517425175251762517725178251792518025181251822518325184251852518625187251882518925190251912519225193251942519525196251972519825199252002520125202252032520425205252062520725208252092521025211252122521325214252152521625217252182521925220252212522225223252242522525226252272522825229252302523125232252332523425235252362523725238252392524025241252422524325244252452524625247252482524925250252512525225253252542525525256252572525825259252602526125262252632526425265252662526725268252692527025271252722527325274252752527625277252782527925280252812528225283252842528525286252872528825289252902529125292252932529425295252962529725298252992530025301253022530325304253052530625307253082530925310253112531225313253142531525316253172531825319253202532125322253232532425325253262532725328253292533025331253322533325334253352533625337253382533925340253412534225343253442534525346253472534825349253502535125352253532535425355253562535725358253592536025361253622536325364253652536625367253682536925370253712537225373253742537525376253772537825379253802538125382253832538425385253862538725388253892539025391253922539325394253952539625397253982539925400254012540225403254042540525406254072540825409254102541125412254132541425415254162541725418254192542025421254222542325424254252542625427254282542925430254312543225433254342543525436254372543825439254402544125442254432544425445254462544725448254492545025451254522545325454254552545625457254582545925460254612546225463254642546525466254672546825469254702547125472254732547425475254762547725478254792548025481254822548325484254852548625487254882548925490254912549225493254942549525496254972549825499255002550125502255032550425505255062550725508255092551025511255122551325514255152551625517255182551925520255212552225523255242552525526255272552825529255302553125532255332553425535255362553725538255392554025541255422554325544255452554625547255482554925550255512555225553255542555525556255572555825559255602556125562255632556425565255662556725568255692557025571255722557325574255752557625577255782557925580255812558225583255842558525586255872558825589255902559125592255932559425595255962559725598255992560025601256022560325604256052560625607256082560925610256112561225613256142561525616256172561825619256202562125622256232562425625256262562725628256292563025631256322563325634256352563625637256382563925640256412564225643256442564525646256472564825649256502565125652256532565425655256562565725658256592566025661256622566325664256652566625667256682566925670256712567225673256742567525676256772567825679256802568125682256832568425685256862568725688256892569025691256922569325694256952569625697256982569925700257012570225703257042570525706257072570825709257102571125712257132571425715257162571725718257192572025721257222572325724257252572625727257282572925730257312573225733257342573525736257372573825739257402574125742257432574425745257462574725748257492575025751257522575325754257552575625757257582575925760257612576225763257642576525766257672576825769257702577125772257732577425775257762577725778257792578025781257822578325784257852578625787257882578925790257912579225793257942579525796257972579825799258002580125802258032580425805258062580725808258092581025811258122581325814258152581625817258182581925820258212582225823258242582525826258272582825829258302583125832258332583425835258362583725838258392584025841258422584325844258452584625847258482584925850258512585225853258542585525856258572585825859258602586125862258632586425865258662586725868258692587025871258722587325874258752587625877258782587925880258812588225883258842588525886258872588825889258902589125892258932589425895258962589725898258992590025901259022590325904259052590625907259082590925910259112591225913259142591525916259172591825919259202592125922259232592425925259262592725928259292593025931259322593325934259352593625937259382593925940259412594225943259442594525946259472594825949259502595125952259532595425955259562595725958259592596025961259622596325964259652596625967259682596925970259712597225973259742597525976259772597825979259802598125982259832598425985259862598725988259892599025991259922599325994259952599625997259982599926000260012600226003260042600526006260072600826009260102601126012260132601426015260162601726018260192602026021260222602326024260252602626027260282602926030260312603226033260342603526036260372603826039260402604126042260432604426045260462604726048260492605026051260522605326054260552605626057260582605926060260612606226063260642606526066260672606826069260702607126072260732607426075260762607726078260792608026081260822608326084260852608626087260882608926090260912609226093260942609526096260972609826099261002610126102261032610426105261062610726108261092611026111261122611326114261152611626117261182611926120261212612226123261242612526126261272612826129261302613126132261332613426135261362613726138261392614026141261422614326144261452614626147261482614926150261512615226153261542615526156261572615826159261602616126162261632616426165261662616726168261692617026171261722617326174261752617626177261782617926180261812618226183261842618526186261872618826189261902619126192261932619426195261962619726198261992620026201262022620326204262052620626207262082620926210262112621226213262142621526216262172621826219262202622126222262232622426225262262622726228262292623026231262322623326234262352623626237262382623926240262412624226243262442624526246262472624826249262502625126252262532625426255262562625726258262592626026261262622626326264262652626626267262682626926270262712627226273262742627526276262772627826279262802628126282262832628426285262862628726288262892629026291262922629326294262952629626297262982629926300263012630226303263042630526306263072630826309263102631126312263132631426315263162631726318263192632026321263222632326324263252632626327263282632926330263312633226333263342633526336263372633826339263402634126342263432634426345263462634726348263492635026351263522635326354263552635626357263582635926360263612636226363263642636526366263672636826369263702637126372263732637426375263762637726378263792638026381263822638326384263852638626387263882638926390263912639226393263942639526396263972639826399264002640126402264032640426405264062640726408264092641026411264122641326414264152641626417264182641926420264212642226423264242642526426264272642826429264302643126432264332643426435264362643726438264392644026441264422644326444264452644626447264482644926450264512645226453264542645526456264572645826459264602646126462264632646426465264662646726468264692647026471264722647326474264752647626477264782647926480264812648226483264842648526486264872648826489264902649126492264932649426495264962649726498264992650026501265022650326504265052650626507265082650926510265112651226513265142651526516265172651826519265202652126522265232652426525265262652726528265292653026531265322653326534265352653626537265382653926540265412654226543265442654526546265472654826549265502655126552265532655426555265562655726558265592656026561265622656326564265652656626567265682656926570265712657226573265742657526576265772657826579265802658126582265832658426585265862658726588265892659026591265922659326594265952659626597265982659926600266012660226603266042660526606266072660826609266102661126612266132661426615266162661726618266192662026621266222662326624266252662626627266282662926630266312663226633266342663526636266372663826639266402664126642266432664426645266462664726648266492665026651266522665326654266552665626657266582665926660266612666226663266642666526666266672666826669266702667126672266732667426675266762667726678266792668026681266822668326684266852668626687266882668926690266912669226693266942669526696266972669826699267002670126702267032670426705267062670726708267092671026711267122671326714267152671626717267182671926720267212672226723267242672526726267272672826729267302673126732267332673426735267362673726738267392674026741267422674326744267452674626747267482674926750267512675226753267542675526756267572675826759267602676126762267632676426765267662676726768267692677026771267722677326774267752677626777267782677926780267812678226783267842678526786267872678826789267902679126792267932679426795267962679726798267992680026801268022680326804268052680626807268082680926810268112681226813268142681526816268172681826819268202682126822268232682426825268262682726828268292683026831268322683326834268352683626837268382683926840268412684226843268442684526846268472684826849268502685126852268532685426855268562685726858268592686026861268622686326864268652686626867268682686926870268712687226873268742687526876268772687826879268802688126882268832688426885268862688726888268892689026891268922689326894268952689626897268982689926900269012690226903269042690526906269072690826909269102691126912269132691426915269162691726918269192692026921269222692326924269252692626927269282692926930269312693226933269342693526936269372693826939269402694126942269432694426945269462694726948269492695026951269522695326954269552695626957269582695926960269612696226963269642696526966269672696826969269702697126972269732697426975269762697726978269792698026981269822698326984269852698626987269882698926990269912699226993269942699526996269972699826999270002700127002270032700427005270062700727008270092701027011270122701327014270152701627017270182701927020270212702227023270242702527026270272702827029270302703127032270332703427035270362703727038270392704027041270422704327044270452704627047270482704927050270512705227053270542705527056270572705827059270602706127062270632706427065270662706727068270692707027071270722707327074270752707627077270782707927080270812708227083270842708527086270872708827089270902709127092270932709427095270962709727098270992710027101271022710327104271052710627107271082710927110271112711227113271142711527116271172711827119271202712127122271232712427125271262712727128271292713027131271322713327134271352713627137271382713927140271412714227143271442714527146271472714827149271502715127152271532715427155271562715727158271592716027161271622716327164271652716627167271682716927170271712717227173271742717527176271772717827179271802718127182271832718427185271862718727188271892719027191271922719327194271952719627197271982719927200272012720227203272042720527206272072720827209272102721127212272132721427215272162721727218272192722027221272222722327224272252722627227272282722927230272312723227233272342723527236272372723827239272402724127242272432724427245272462724727248272492725027251272522725327254272552725627257272582725927260272612726227263272642726527266272672726827269272702727127272272732727427275272762727727278272792728027281272822728327284272852728627287272882728927290272912729227293272942729527296272972729827299273002730127302273032730427305273062730727308273092731027311273122731327314273152731627317273182731927320273212732227323273242732527326273272732827329273302733127332273332733427335273362733727338273392734027341273422734327344273452734627347273482734927350273512735227353273542735527356273572735827359273602736127362273632736427365273662736727368273692737027371273722737327374273752737627377273782737927380273812738227383273842738527386273872738827389273902739127392273932739427395273962739727398273992740027401274022740327404274052740627407274082740927410274112741227413274142741527416274172741827419274202742127422274232742427425274262742727428274292743027431274322743327434274352743627437274382743927440274412744227443274442744527446274472744827449274502745127452274532745427455274562745727458274592746027461274622746327464274652746627467274682746927470274712747227473274742747527476274772747827479274802748127482274832748427485274862748727488274892749027491274922749327494274952749627497274982749927500275012750227503275042750527506275072750827509275102751127512275132751427515275162751727518275192752027521275222752327524275252752627527275282752927530275312753227533275342753527536275372753827539275402754127542275432754427545275462754727548275492755027551275522755327554275552755627557275582755927560275612756227563275642756527566275672756827569275702757127572275732757427575275762757727578275792758027581275822758327584275852758627587275882758927590275912759227593275942759527596275972759827599276002760127602276032760427605276062760727608276092761027611276122761327614276152761627617276182761927620276212762227623276242762527626276272762827629276302763127632276332763427635276362763727638276392764027641276422764327644276452764627647276482764927650276512765227653276542765527656276572765827659276602766127662276632766427665276662766727668276692767027671276722767327674276752767627677276782767927680276812768227683276842768527686276872768827689276902769127692276932769427695276962769727698276992770027701277022770327704277052770627707277082770927710277112771227713277142771527716277172771827719277202772127722277232772427725277262772727728277292773027731277322773327734277352773627737277382773927740277412774227743277442774527746277472774827749277502775127752277532775427755277562775727758277592776027761277622776327764277652776627767277682776927770277712777227773277742777527776277772777827779277802778127782277832778427785277862778727788277892779027791277922779327794277952779627797277982779927800278012780227803278042780527806278072780827809278102781127812278132781427815278162781727818278192782027821278222782327824278252782627827278282782927830278312783227833278342783527836278372783827839278402784127842278432784427845278462784727848278492785027851278522785327854278552785627857278582785927860278612786227863278642786527866278672786827869278702787127872278732787427875278762787727878278792788027881278822788327884278852788627887278882788927890278912789227893278942789527896278972789827899279002790127902279032790427905279062790727908279092791027911279122791327914279152791627917279182791927920279212792227923279242792527926279272792827929279302793127932279332793427935279362793727938279392794027941279422794327944279452794627947279482794927950279512795227953279542795527956279572795827959279602796127962279632796427965279662796727968279692797027971279722797327974279752797627977279782797927980279812798227983279842798527986279872798827989279902799127992279932799427995279962799727998279992800028001280022800328004280052800628007280082800928010280112801228013280142801528016280172801828019280202802128022280232802428025280262802728028280292803028031280322803328034280352803628037280382803928040280412804228043280442804528046280472804828049280502805128052280532805428055280562805728058280592806028061280622806328064280652806628067280682806928070280712807228073280742807528076280772807828079280802808128082280832808428085280862808728088280892809028091280922809328094280952809628097280982809928100281012810228103281042810528106281072810828109281102811128112281132811428115281162811728118281192812028121281222812328124281252812628127281282812928130281312813228133281342813528136281372813828139281402814128142281432814428145281462814728148281492815028151281522815328154281552815628157281582815928160281612816228163281642816528166281672816828169281702817128172281732817428175281762817728178281792818028181281822818328184281852818628187281882818928190281912819228193281942819528196281972819828199282002820128202282032820428205282062820728208282092821028211282122821328214282152821628217282182821928220282212822228223282242822528226282272822828229282302823128232282332823428235282362823728238282392824028241282422824328244282452824628247282482824928250282512825228253282542825528256282572825828259282602826128262282632826428265282662826728268282692827028271282722827328274282752827628277282782827928280282812828228283282842828528286282872828828289282902829128292282932829428295282962829728298282992830028301283022830328304283052830628307283082830928310283112831228313283142831528316283172831828319283202832128322283232832428325283262832728328283292833028331283322833328334283352833628337283382833928340283412834228343283442834528346283472834828349283502835128352283532835428355283562835728358283592836028361283622836328364283652836628367283682836928370283712837228373283742837528376283772837828379283802838128382283832838428385283862838728388283892839028391283922839328394283952839628397283982839928400284012840228403284042840528406284072840828409284102841128412284132841428415284162841728418284192842028421284222842328424284252842628427284282842928430284312843228433284342843528436284372843828439284402844128442284432844428445284462844728448284492845028451284522845328454284552845628457284582845928460284612846228463284642846528466284672846828469284702847128472284732847428475284762847728478284792848028481284822848328484284852848628487284882848928490284912849228493284942849528496284972849828499285002850128502285032850428505285062850728508285092851028511285122851328514285152851628517285182851928520285212852228523285242852528526285272852828529285302853128532285332853428535285362853728538285392854028541285422854328544285452854628547285482854928550285512855228553285542855528556285572855828559285602856128562285632856428565285662856728568285692857028571285722857328574285752857628577285782857928580285812858228583285842858528586285872858828589285902859128592285932859428595285962859728598285992860028601286022860328604286052860628607286082860928610286112861228613286142861528616286172861828619286202862128622286232862428625286262862728628286292863028631286322863328634286352863628637286382863928640286412864228643286442864528646286472864828649286502865128652286532865428655286562865728658286592866028661286622866328664286652866628667286682866928670286712867228673286742867528676286772867828679286802868128682286832868428685286862868728688286892869028691286922869328694286952869628697286982869928700287012870228703287042870528706287072870828709287102871128712287132871428715287162871728718287192872028721287222872328724287252872628727287282872928730287312873228733287342873528736287372873828739287402874128742287432874428745287462874728748287492875028751287522875328754287552875628757287582875928760287612876228763287642876528766287672876828769287702877128772287732877428775287762877728778287792878028781287822878328784287852878628787287882878928790287912879228793287942879528796287972879828799288002880128802288032880428805288062880728808288092881028811288122881328814288152881628817288182881928820288212882228823288242882528826288272882828829288302883128832288332883428835288362883728838288392884028841288422884328844288452884628847288482884928850288512885228853288542885528856288572885828859288602886128862288632886428865288662886728868288692887028871288722887328874288752887628877288782887928880288812888228883288842888528886288872888828889288902889128892288932889428895288962889728898288992890028901289022890328904289052890628907289082890928910289112891228913289142891528916289172891828919289202892128922289232892428925289262892728928289292893028931289322893328934289352893628937289382893928940289412894228943289442894528946289472894828949289502895128952289532895428955289562895728958289592896028961289622896328964289652896628967289682896928970289712897228973289742897528976289772897828979289802898128982289832898428985289862898728988289892899028991289922899328994289952899628997289982899929000290012900229003290042900529006290072900829009290102901129012290132901429015290162901729018290192902029021290222902329024290252902629027290282902929030290312903229033290342903529036290372903829039290402904129042290432904429045290462904729048290492905029051290522905329054290552905629057290582905929060290612906229063290642906529066290672906829069290702907129072290732907429075290762907729078290792908029081290822908329084290852908629087290882908929090290912909229093290942909529096290972909829099291002910129102291032910429105291062910729108291092911029111291122911329114291152911629117291182911929120291212912229123291242912529126291272912829129291302913129132291332913429135291362913729138291392914029141291422914329144291452914629147291482914929150291512915229153291542915529156291572915829159291602916129162291632916429165291662916729168291692917029171291722917329174291752917629177291782917929180291812918229183291842918529186291872918829189291902919129192291932919429195291962919729198291992920029201292022920329204292052920629207292082920929210292112921229213292142921529216292172921829219292202922129222292232922429225292262922729228292292923029231292322923329234292352923629237292382923929240292412924229243292442924529246292472924829249292502925129252292532925429255292562925729258292592926029261292622926329264292652926629267292682926929270292712927229273292742927529276292772927829279292802928129282292832928429285292862928729288292892929029291292922929329294292952929629297292982929929300293012930229303293042930529306293072930829309293102931129312293132931429315293162931729318293192932029321293222932329324293252932629327293282932929330293312933229333293342933529336293372933829339293402934129342293432934429345293462934729348293492935029351293522935329354293552935629357293582935929360293612936229363293642936529366293672936829369293702937129372293732937429375293762937729378293792938029381293822938329384293852938629387293882938929390293912939229393293942939529396293972939829399294002940129402294032940429405294062940729408294092941029411294122941329414294152941629417294182941929420294212942229423294242942529426294272942829429294302943129432294332943429435294362943729438294392944029441294422944329444294452944629447294482944929450294512945229453294542945529456294572945829459294602946129462294632946429465294662946729468294692947029471294722947329474294752947629477294782947929480294812948229483294842948529486294872948829489294902949129492294932949429495294962949729498294992950029501295022950329504295052950629507295082950929510295112951229513295142951529516295172951829519295202952129522295232952429525295262952729528295292953029531295322953329534295352953629537295382953929540295412954229543295442954529546295472954829549295502955129552295532955429555295562955729558295592956029561295622956329564295652956629567295682956929570295712957229573295742957529576295772957829579295802958129582295832958429585295862958729588295892959029591295922959329594295952959629597295982959929600296012960229603296042960529606296072960829609296102961129612296132961429615296162961729618296192962029621296222962329624296252962629627296282962929630296312963229633296342963529636296372963829639296402964129642296432964429645296462964729648296492965029651296522965329654296552965629657296582965929660296612966229663296642966529666296672966829669296702967129672296732967429675296762967729678296792968029681296822968329684296852968629687296882968929690296912969229693296942969529696296972969829699297002970129702297032970429705297062970729708297092971029711297122971329714297152971629717297182971929720297212972229723297242972529726297272972829729297302973129732297332973429735297362973729738297392974029741297422974329744297452974629747297482974929750297512975229753297542975529756297572975829759297602976129762297632976429765297662976729768297692977029771297722977329774297752977629777297782977929780297812978229783297842978529786297872978829789297902979129792297932979429795297962979729798297992980029801298022980329804298052980629807298082980929810298112981229813298142981529816298172981829819298202982129822298232982429825298262982729828298292983029831298322983329834298352983629837298382983929840298412984229843298442984529846298472984829849298502985129852298532985429855298562985729858298592986029861298622986329864298652986629867298682986929870298712987229873298742987529876298772987829879298802988129882298832988429885298862988729888298892989029891298922989329894298952989629897298982989929900299012990229903299042990529906299072990829909299102991129912299132991429915299162991729918299192992029921299222992329924299252992629927299282992929930299312993229933299342993529936299372993829939299402994129942299432994429945299462994729948299492995029951299522995329954299552995629957299582995929960299612996229963299642996529966299672996829969299702997129972299732997429975299762997729978299792998029981299822998329984299852998629987299882998929990299912999229993299942999529996299972999829999300003000130002300033000430005300063000730008300093001030011300123001330014300153001630017300183001930020300213002230023300243002530026300273002830029300303003130032300333003430035300363003730038300393004030041300423004330044300453004630047300483004930050300513005230053300543005530056300573005830059300603006130062300633006430065300663006730068300693007030071300723007330074300753007630077300783007930080300813008230083300843008530086300873008830089300903009130092300933009430095300963009730098300993010030101301023010330104301053010630107301083010930110301113011230113301143011530116301173011830119301203012130122301233012430125301263012730128301293013030131301323013330134301353013630137301383013930140301413014230143301443014530146301473014830149301503015130152301533015430155301563015730158301593016030161301623016330164301653016630167301683016930170301713017230173301743017530176301773017830179301803018130182301833018430185301863018730188301893019030191301923019330194301953019630197301983019930200302013020230203302043020530206302073020830209302103021130212302133021430215302163021730218302193022030221302223022330224302253022630227302283022930230302313023230233302343023530236302373023830239302403024130242302433024430245302463024730248302493025030251302523025330254302553025630257302583025930260302613026230263302643026530266302673026830269302703027130272302733027430275302763027730278302793028030281302823028330284302853028630287302883028930290302913029230293302943029530296302973029830299303003030130302303033030430305303063030730308303093031030311303123031330314303153031630317303183031930320303213032230323303243032530326303273032830329303303033130332303333033430335303363033730338303393034030341303423034330344303453034630347303483034930350303513035230353303543035530356303573035830359303603036130362303633036430365303663036730368303693037030371303723037330374303753037630377303783037930380303813038230383303843038530386303873038830389303903039130392303933039430395303963039730398303993040030401304023040330404304053040630407304083040930410304113041230413304143041530416304173041830419304203042130422304233042430425304263042730428304293043030431304323043330434304353043630437304383043930440304413044230443304443044530446304473044830449304503045130452304533045430455304563045730458304593046030461304623046330464304653046630467304683046930470304713047230473304743047530476304773047830479304803048130482304833048430485304863048730488304893049030491304923049330494304953049630497304983049930500305013050230503305043050530506305073050830509305103051130512305133051430515305163051730518305193052030521305223052330524305253052630527305283052930530305313053230533305343053530536305373053830539305403054130542305433054430545305463054730548305493055030551305523055330554305553055630557305583055930560305613056230563305643056530566305673056830569305703057130572305733057430575305763057730578305793058030581305823058330584305853058630587305883058930590305913059230593305943059530596305973059830599306003060130602306033060430605306063060730608306093061030611306123061330614306153061630617306183061930620306213062230623306243062530626306273062830629306303063130632306333063430635306363063730638306393064030641306423064330644306453064630647306483064930650306513065230653306543065530656306573065830659306603066130662306633066430665306663066730668306693067030671306723067330674306753067630677306783067930680306813068230683306843068530686306873068830689306903069130692306933069430695306963069730698306993070030701307023070330704307053070630707307083070930710307113071230713307143071530716307173071830719307203072130722307233072430725307263072730728307293073030731307323073330734307353073630737307383073930740307413074230743307443074530746307473074830749307503075130752307533075430755307563075730758307593076030761307623076330764307653076630767307683076930770307713077230773307743077530776307773077830779307803078130782307833078430785307863078730788307893079030791307923079330794307953079630797307983079930800308013080230803308043080530806308073080830809308103081130812308133081430815308163081730818308193082030821308223082330824308253082630827308283082930830308313083230833308343083530836308373083830839308403084130842308433084430845308463084730848308493085030851308523085330854308553085630857308583085930860308613086230863308643086530866308673086830869308703087130872308733087430875308763087730878308793088030881308823088330884308853088630887308883088930890308913089230893308943089530896308973089830899309003090130902309033090430905309063090730908309093091030911309123091330914309153091630917309183091930920309213092230923309243092530926309273092830929309303093130932309333093430935309363093730938309393094030941309423094330944309453094630947309483094930950309513095230953309543095530956309573095830959309603096130962309633096430965309663096730968309693097030971309723097330974309753097630977309783097930980309813098230983309843098530986309873098830989309903099130992309933099430995309963099730998309993100031001310023100331004310053100631007310083100931010310113101231013310143101531016310173101831019310203102131022310233102431025310263102731028310293103031031310323103331034310353103631037310383103931040310413104231043310443104531046310473104831049310503105131052310533105431055310563105731058310593106031061310623106331064310653106631067310683106931070310713107231073310743107531076310773107831079310803108131082310833108431085310863108731088310893109031091310923109331094310953109631097310983109931100311013110231103311043110531106311073110831109311103111131112311133111431115311163111731118311193112031121311223112331124311253112631127311283112931130311313113231133311343113531136311373113831139311403114131142311433114431145311463114731148311493115031151311523115331154311553115631157311583115931160311613116231163311643116531166311673116831169311703117131172311733117431175311763117731178311793118031181311823118331184311853118631187311883118931190311913119231193311943119531196311973119831199312003120131202312033120431205312063120731208312093121031211312123121331214312153121631217312183121931220312213122231223312243122531226312273122831229312303123131232312333123431235312363123731238312393124031241312423124331244312453124631247312483124931250312513125231253312543125531256312573125831259312603126131262312633126431265312663126731268312693127031271312723127331274312753127631277312783127931280312813128231283312843128531286312873128831289312903129131292312933129431295312963129731298312993130031301313023130331304313053130631307313083130931310313113131231313313143131531316313173131831319313203132131322313233132431325313263132731328313293133031331313323133331334313353133631337313383133931340313413134231343313443134531346313473134831349313503135131352313533135431355313563135731358313593136031361313623136331364313653136631367313683136931370313713137231373313743137531376313773137831379313803138131382313833138431385313863138731388313893139031391313923139331394313953139631397313983139931400314013140231403314043140531406314073140831409314103141131412314133141431415314163141731418314193142031421314223142331424314253142631427314283142931430314313143231433314343143531436314373143831439314403144131442314433144431445314463144731448314493145031451314523145331454314553145631457314583145931460314613146231463314643146531466314673146831469314703147131472314733147431475314763147731478314793148031481314823148331484314853148631487314883148931490314913149231493314943149531496314973149831499315003150131502315033150431505315063150731508315093151031511315123151331514315153151631517315183151931520315213152231523315243152531526315273152831529315303153131532315333153431535315363153731538315393154031541315423154331544315453154631547315483154931550315513155231553315543155531556315573155831559315603156131562315633156431565315663156731568315693157031571315723157331574315753157631577315783157931580315813158231583315843158531586315873158831589315903159131592315933159431595315963159731598315993160031601316023160331604316053160631607316083160931610316113161231613316143161531616316173161831619316203162131622316233162431625316263162731628316293163031631316323163331634316353163631637316383163931640316413164231643316443164531646316473164831649316503165131652316533165431655316563165731658316593166031661316623166331664316653166631667316683166931670316713167231673316743167531676316773167831679316803168131682316833168431685316863168731688316893169031691316923169331694316953169631697316983169931700317013170231703317043170531706317073170831709317103171131712317133171431715317163171731718317193172031721317223172331724317253172631727317283172931730317313173231733317343173531736317373173831739317403174131742317433174431745317463174731748317493175031751317523175331754317553175631757317583175931760317613176231763317643176531766317673176831769317703177131772317733177431775317763177731778317793178031781317823178331784317853178631787317883178931790317913179231793317943179531796317973179831799318003180131802318033180431805318063180731808318093181031811318123181331814318153181631817318183181931820318213182231823318243182531826318273182831829318303183131832318333183431835318363183731838318393184031841318423184331844318453184631847318483184931850318513185231853318543185531856318573185831859318603186131862318633186431865318663186731868318693187031871318723187331874318753187631877318783187931880318813188231883318843188531886318873188831889318903189131892318933189431895318963189731898318993190031901319023190331904319053190631907319083190931910319113191231913319143191531916319173191831919319203192131922319233192431925319263192731928319293193031931319323193331934319353193631937319383193931940319413194231943319443194531946319473194831949319503195131952319533195431955319563195731958319593196031961319623196331964319653196631967319683196931970319713197231973319743197531976319773197831979319803198131982319833198431985319863198731988319893199031991319923199331994319953199631997319983199932000320013200232003320043200532006320073200832009320103201132012320133201432015320163201732018320193202032021320223202332024320253202632027320283202932030320313203232033320343203532036320373203832039320403204132042320433204432045320463204732048320493205032051320523205332054320553205632057320583205932060320613206232063320643206532066320673206832069320703207132072320733207432075320763207732078320793208032081320823208332084320853208632087320883208932090320913209232093320943209532096320973209832099321003210132102321033210432105321063210732108321093211032111321123211332114321153211632117321183211932120321213212232123321243212532126321273212832129321303213132132321333213432135321363213732138321393214032141321423214332144321453214632147321483214932150321513215232153321543215532156321573215832159321603216132162321633216432165321663216732168321693217032171321723217332174321753217632177321783217932180321813218232183321843218532186321873218832189321903219132192321933219432195321963219732198321993220032201322023220332204322053220632207322083220932210322113221232213322143221532216322173221832219322203222132222322233222432225322263222732228322293223032231322323223332234322353223632237322383223932240322413224232243322443224532246322473224832249322503225132252322533225432255322563225732258322593226032261322623226332264322653226632267322683226932270322713227232273322743227532276322773227832279322803228132282322833228432285322863228732288322893229032291322923229332294322953229632297322983229932300323013230232303323043230532306323073230832309323103231132312323133231432315323163231732318323193232032321323223232332324323253232632327323283232932330323313233232333323343233532336323373233832339323403234132342323433234432345323463234732348323493235032351323523235332354323553235632357323583235932360323613236232363323643236532366323673236832369323703237132372323733237432375323763237732378323793238032381323823238332384323853238632387323883238932390323913239232393323943239532396323973239832399324003240132402324033240432405324063240732408324093241032411324123241332414324153241632417324183241932420324213242232423324243242532426324273242832429324303243132432324333243432435324363243732438324393244032441324423244332444324453244632447324483244932450324513245232453324543245532456324573245832459324603246132462324633246432465324663246732468324693247032471324723247332474324753247632477324783247932480324813248232483324843248532486324873248832489324903249132492324933249432495324963249732498324993250032501325023250332504325053250632507325083250932510325113251232513325143251532516325173251832519325203252132522325233252432525325263252732528325293253032531325323253332534325353253632537325383253932540325413254232543325443254532546325473254832549325503255132552325533255432555325563255732558325593256032561325623256332564325653256632567325683256932570325713257232573325743257532576325773257832579325803258132582325833258432585325863258732588325893259032591325923259332594325953259632597325983259932600326013260232603326043260532606326073260832609326103261132612326133261432615326163261732618326193262032621326223262332624326253262632627326283262932630326313263232633326343263532636326373263832639326403264132642326433264432645326463264732648326493265032651326523265332654326553265632657326583265932660326613266232663326643266532666326673266832669326703267132672326733267432675326763267732678326793268032681326823268332684326853268632687326883268932690326913269232693326943269532696326973269832699327003270132702327033270432705327063270732708327093271032711327123271332714327153271632717327183271932720327213272232723327243272532726327273272832729327303273132732327333273432735327363273732738327393274032741327423274332744327453274632747327483274932750327513275232753327543275532756327573275832759327603276132762327633276432765327663276732768327693277032771327723277332774327753277632777327783277932780327813278232783327843278532786327873278832789327903279132792327933279432795327963279732798327993280032801328023280332804328053280632807328083280932810328113281232813328143281532816328173281832819328203282132822328233282432825328263282732828328293283032831328323283332834328353283632837328383283932840328413284232843328443284532846328473284832849328503285132852328533285432855328563285732858328593286032861328623286332864328653286632867328683286932870328713287232873328743287532876328773287832879328803288132882328833288432885328863288732888328893289032891328923289332894328953289632897328983289932900329013290232903329043290532906329073290832909329103291132912329133291432915329163291732918329193292032921329223292332924329253292632927329283292932930329313293232933329343293532936329373293832939329403294132942329433294432945329463294732948329493295032951329523295332954329553295632957329583295932960329613296232963329643296532966329673296832969329703297132972329733297432975329763297732978329793298032981329823298332984329853298632987329883298932990329913299232993329943299532996329973299832999330003300133002330033300433005330063300733008330093301033011330123301333014330153301633017330183301933020330213302233023330243302533026330273302833029330303303133032330333303433035330363303733038330393304033041330423304333044330453304633047330483304933050330513305233053330543305533056330573305833059330603306133062330633306433065330663306733068330693307033071330723307333074330753307633077330783307933080330813308233083330843308533086330873308833089330903309133092330933309433095330963309733098330993310033101331023310333104331053310633107331083310933110331113311233113331143311533116331173311833119331203312133122331233312433125331263312733128331293313033131331323313333134331353313633137331383313933140331413314233143331443314533146331473314833149331503315133152331533315433155331563315733158331593316033161331623316333164331653316633167331683316933170331713317233173331743317533176331773317833179331803318133182331833318433185331863318733188331893319033191331923319333194331953319633197331983319933200332013320233203332043320533206332073320833209332103321133212332133321433215332163321733218332193322033221332223322333224332253322633227332283322933230332313323233233332343323533236332373323833239332403324133242332433324433245332463324733248332493325033251332523325333254332553325633257332583325933260332613326233263332643326533266332673326833269332703327133272332733327433275332763327733278332793328033281332823328333284332853328633287332883328933290332913329233293332943329533296332973329833299333003330133302333033330433305333063330733308333093331033311333123331333314333153331633317333183331933320333213332233323333243332533326333273332833329333303333133332333333333433335333363333733338333393334033341333423334333344333453334633347333483334933350333513335233353333543335533356333573335833359333603336133362333633336433365333663336733368333693337033371333723337333374333753337633377333783337933380333813338233383333843338533386333873338833389333903339133392333933339433395333963339733398333993340033401334023340333404334053340633407334083340933410334113341233413334143341533416334173341833419334203342133422334233342433425334263342733428334293343033431334323343333434334353343633437334383343933440334413344233443334443344533446334473344833449334503345133452334533345433455334563345733458334593346033461334623346333464334653346633467334683346933470334713347233473334743347533476334773347833479334803348133482334833348433485334863348733488334893349033491334923349333494334953349633497334983349933500335013350233503335043350533506335073350833509335103351133512335133351433515335163351733518335193352033521335223352333524335253352633527335283352933530335313353233533335343353533536335373353833539335403354133542335433354433545335463354733548335493355033551335523355333554335553355633557335583355933560335613356233563335643356533566335673356833569335703357133572335733357433575335763357733578335793358033581335823358333584335853358633587335883358933590335913359233593335943359533596335973359833599336003360133602336033360433605336063360733608336093361033611336123361333614336153361633617336183361933620336213362233623336243362533626336273362833629336303363133632336333363433635336363363733638336393364033641336423364333644336453364633647336483364933650336513365233653336543365533656336573365833659336603366133662336633366433665336663366733668336693367033671336723367333674336753367633677336783367933680336813368233683336843368533686336873368833689336903369133692336933369433695336963369733698336993370033701337023370333704337053370633707337083370933710337113371233713337143371533716337173371833719337203372133722337233372433725337263372733728337293373033731337323373333734337353373633737337383373933740337413374233743337443374533746337473374833749337503375133752337533375433755337563375733758337593376033761337623376333764337653376633767337683376933770337713377233773337743377533776337773377833779337803378133782337833378433785337863378733788337893379033791337923379333794337953379633797337983379933800338013380233803338043380533806338073380833809338103381133812338133381433815338163381733818338193382033821338223382333824338253382633827338283382933830338313383233833338343383533836338373383833839338403384133842338433384433845338463384733848338493385033851338523385333854338553385633857338583385933860338613386233863338643386533866338673386833869338703387133872338733387433875338763387733878338793388033881338823388333884338853388633887338883388933890338913389233893338943389533896338973389833899339003390133902339033390433905339063390733908339093391033911339123391333914339153391633917339183391933920339213392233923339243392533926339273392833929339303393133932339333393433935339363393733938339393394033941339423394333944339453394633947339483394933950339513395233953339543395533956339573395833959339603396133962339633396433965339663396733968339693397033971339723397333974339753397633977339783397933980339813398233983339843398533986339873398833989339903399133992339933399433995339963399733998339993400034001340023400334004340053400634007340083400934010340113401234013340143401534016340173401834019340203402134022340233402434025340263402734028340293403034031340323403334034340353403634037340383403934040340413404234043340443404534046340473404834049340503405134052340533405434055340563405734058340593406034061340623406334064340653406634067340683406934070340713407234073340743407534076340773407834079340803408134082340833408434085340863408734088340893409034091340923409334094340953409634097340983409934100341013410234103341043410534106341073410834109341103411134112341133411434115341163411734118341193412034121341223412334124341253412634127341283412934130341313413234133341343413534136341373413834139341403414134142341433414434145341463414734148341493415034151341523415334154341553415634157341583415934160341613416234163341643416534166341673416834169341703417134172341733417434175341763417734178341793418034181341823418334184341853418634187341883418934190341913419234193341943419534196341973419834199342003420134202342033420434205342063420734208342093421034211342123421334214342153421634217342183421934220342213422234223342243422534226342273422834229342303423134232342333423434235342363423734238342393424034241342423424334244342453424634247342483424934250342513425234253342543425534256342573425834259342603426134262342633426434265342663426734268342693427034271342723427334274342753427634277342783427934280342813428234283342843428534286342873428834289342903429134292342933429434295342963429734298342993430034301343023430334304343053430634307343083430934310343113431234313343143431534316343173431834319343203432134322343233432434325343263432734328343293433034331343323433334334343353433634337343383433934340343413434234343343443434534346343473434834349343503435134352343533435434355343563435734358343593436034361343623436334364343653436634367343683436934370343713437234373343743437534376343773437834379343803438134382343833438434385343863438734388343893439034391343923439334394343953439634397343983439934400344013440234403344043440534406344073440834409344103441134412344133441434415344163441734418344193442034421344223442334424344253442634427344283442934430344313443234433344343443534436344373443834439344403444134442344433444434445344463444734448344493445034451344523445334454344553445634457344583445934460344613446234463344643446534466344673446834469344703447134472344733447434475344763447734478344793448034481344823448334484344853448634487344883448934490344913449234493344943449534496344973449834499345003450134502345033450434505345063450734508345093451034511345123451334514345153451634517345183451934520345213452234523345243452534526345273452834529345303453134532345333453434535345363453734538345393454034541345423454334544345453454634547345483454934550345513455234553345543455534556345573455834559345603456134562345633456434565345663456734568345693457034571345723457334574345753457634577345783457934580345813458234583345843458534586345873458834589345903459134592345933459434595345963459734598345993460034601346023460334604346053460634607346083460934610346113461234613346143461534616346173461834619346203462134622346233462434625346263462734628346293463034631346323463334634346353463634637346383463934640346413464234643346443464534646346473464834649346503465134652346533465434655346563465734658346593466034661346623466334664346653466634667346683466934670346713467234673346743467534676346773467834679346803468134682346833468434685346863468734688346893469034691346923469334694346953469634697346983469934700347013470234703347043470534706347073470834709347103471134712347133471434715347163471734718347193472034721347223472334724347253472634727347283472934730347313473234733347343473534736347373473834739347403474134742347433474434745347463474734748347493475034751347523475334754347553475634757347583475934760347613476234763347643476534766347673476834769347703477134772347733477434775347763477734778347793478034781347823478334784347853478634787347883478934790347913479234793347943479534796347973479834799348003480134802348033480434805348063480734808348093481034811348123481334814348153481634817348183481934820348213482234823348243482534826348273482834829348303483134832348333483434835348363483734838348393484034841348423484334844348453484634847348483484934850348513485234853348543485534856348573485834859348603486134862348633486434865348663486734868348693487034871348723487334874348753487634877348783487934880348813488234883348843488534886348873488834889348903489134892348933489434895348963489734898348993490034901349023490334904349053490634907349083490934910349113491234913349143491534916349173491834919349203492134922349233492434925349263492734928349293493034931349323493334934349353493634937349383493934940349413494234943349443494534946349473494834949349503495134952349533495434955349563495734958349593496034961349623496334964349653496634967349683496934970349713497234973349743497534976349773497834979349803498134982349833498434985349863498734988349893499034991349923499334994349953499634997349983499935000350013500235003350043500535006350073500835009350103501135012350133501435015350163501735018350193502035021350223502335024350253502635027350283502935030350313503235033350343503535036350373503835039350403504135042350433504435045350463504735048350493505035051350523505335054350553505635057350583505935060350613506235063350643506535066350673506835069350703507135072350733507435075350763507735078350793508035081350823508335084350853508635087350883508935090350913509235093350943509535096350973509835099351003510135102351033510435105351063510735108351093511035111351123511335114351153511635117351183511935120351213512235123351243512535126351273512835129351303513135132351333513435135351363513735138351393514035141351423514335144351453514635147351483514935150351513515235153351543515535156351573515835159351603516135162351633516435165351663516735168351693517035171351723517335174351753517635177351783517935180351813518235183351843518535186351873518835189351903519135192351933519435195351963519735198351993520035201352023520335204352053520635207352083520935210352113521235213352143521535216352173521835219352203522135222352233522435225352263522735228352293523035231352323523335234352353523635237352383523935240352413524235243352443524535246352473524835249352503525135252352533525435255352563525735258352593526035261352623526335264352653526635267352683526935270352713527235273352743527535276352773527835279352803528135282352833528435285352863528735288352893529035291352923529335294352953529635297352983529935300353013530235303353043530535306353073530835309353103531135312353133531435315353163531735318353193532035321353223532335324353253532635327353283532935330353313533235333353343533535336353373533835339353403534135342353433534435345353463534735348353493535035351353523535335354353553535635357353583535935360353613536235363353643536535366353673536835369353703537135372353733537435375353763537735378353793538035381353823538335384353853538635387353883538935390353913539235393353943539535396353973539835399354003540135402354033540435405354063540735408354093541035411354123541335414354153541635417354183541935420354213542235423354243542535426354273542835429354303543135432354333543435435354363543735438354393544035441354423544335444354453544635447354483544935450354513545235453354543545535456354573545835459354603546135462354633546435465354663546735468354693547035471354723547335474354753547635477354783547935480354813548235483354843548535486354873548835489354903549135492354933549435495354963549735498354993550035501355023550335504355053550635507355083550935510355113551235513355143551535516355173551835519355203552135522355233552435525355263552735528355293553035531355323553335534355353553635537355383553935540355413554235543355443554535546355473554835549355503555135552355533555435555355563555735558355593556035561355623556335564355653556635567355683556935570355713557235573355743557535576355773557835579355803558135582355833558435585355863558735588355893559035591355923559335594355953559635597355983559935600356013560235603356043560535606356073560835609356103561135612356133561435615356163561735618356193562035621356223562335624356253562635627356283562935630356313563235633356343563535636356373563835639356403564135642356433564435645356463564735648356493565035651356523565335654356553565635657356583565935660356613566235663356643566535666356673566835669356703567135672356733567435675356763567735678356793568035681356823568335684356853568635687356883568935690356913569235693356943569535696356973569835699357003570135702357033570435705357063570735708357093571035711357123571335714357153571635717357183571935720357213572235723357243572535726357273572835729357303573135732357333573435735357363573735738357393574035741357423574335744357453574635747357483574935750357513575235753357543575535756357573575835759357603576135762357633576435765357663576735768357693577035771357723577335774357753577635777357783577935780357813578235783357843578535786357873578835789357903579135792357933579435795357963579735798357993580035801358023580335804358053580635807358083580935810358113581235813358143581535816358173581835819358203582135822358233582435825358263582735828358293583035831358323583335834358353583635837358383583935840358413584235843358443584535846358473584835849358503585135852358533585435855358563585735858358593586035861358623586335864358653586635867358683586935870358713587235873358743587535876358773587835879358803588135882358833588435885358863588735888358893589035891358923589335894358953589635897358983589935900359013590235903359043590535906359073590835909359103591135912359133591435915359163591735918359193592035921359223592335924359253592635927359283592935930359313593235933359343593535936359373593835939359403594135942359433594435945359463594735948359493595035951359523595335954359553595635957359583595935960359613596235963359643596535966359673596835969359703597135972359733597435975359763597735978359793598035981359823598335984359853598635987359883598935990359913599235993359943599535996359973599835999360003600136002360033600436005360063600736008360093601036011360123601336014360153601636017360183601936020360213602236023360243602536026360273602836029360303603136032360333603436035360363603736038360393604036041360423604336044360453604636047360483604936050360513605236053360543605536056360573605836059360603606136062360633606436065360663606736068360693607036071360723607336074360753607636077360783607936080360813608236083360843608536086360873608836089360903609136092360933609436095360963609736098360993610036101361023610336104361053610636107361083610936110361113611236113361143611536116361173611836119361203612136122361233612436125361263612736128361293613036131361323613336134361353613636137361383613936140361413614236143361443614536146361473614836149361503615136152361533615436155361563615736158361593616036161361623616336164361653616636167361683616936170361713617236173361743617536176361773617836179361803618136182361833618436185361863618736188361893619036191361923619336194361953619636197361983619936200362013620236203362043620536206362073620836209362103621136212362133621436215362163621736218362193622036221362223622336224362253622636227362283622936230362313623236233362343623536236362373623836239362403624136242362433624436245362463624736248362493625036251362523625336254362553625636257362583625936260362613626236263362643626536266362673626836269362703627136272362733627436275362763627736278362793628036281362823628336284362853628636287362883628936290362913629236293362943629536296362973629836299363003630136302363033630436305363063630736308363093631036311363123631336314363153631636317363183631936320363213632236323363243632536326363273632836329363303633136332363333633436335363363633736338363393634036341363423634336344363453634636347363483634936350363513635236353363543635536356363573635836359363603636136362363633636436365363663636736368363693637036371363723637336374363753637636377363783637936380363813638236383363843638536386363873638836389363903639136392363933639436395363963639736398363993640036401364023640336404364053640636407364083640936410364113641236413364143641536416364173641836419364203642136422364233642436425364263642736428364293643036431364323643336434364353643636437364383643936440364413644236443364443644536446364473644836449364503645136452364533645436455364563645736458364593646036461364623646336464364653646636467364683646936470364713647236473364743647536476364773647836479364803648136482364833648436485364863648736488364893649036491364923649336494364953649636497364983649936500365013650236503365043650536506365073650836509365103651136512365133651436515365163651736518365193652036521365223652336524365253652636527365283652936530365313653236533365343653536536365373653836539365403654136542365433654436545365463654736548365493655036551365523655336554365553655636557365583655936560365613656236563365643656536566365673656836569365703657136572365733657436575365763657736578365793658036581365823658336584365853658636587365883658936590365913659236593365943659536596365973659836599366003660136602366033660436605366063660736608366093661036611366123661336614366153661636617366183661936620366213662236623366243662536626366273662836629366303663136632366333663436635366363663736638366393664036641366423664336644366453664636647366483664936650366513665236653366543665536656366573665836659366603666136662366633666436665366663666736668366693667036671366723667336674366753667636677366783667936680366813668236683366843668536686366873668836689366903669136692366933669436695366963669736698366993670036701367023670336704367053670636707367083670936710367113671236713367143671536716367173671836719367203672136722367233672436725367263672736728367293673036731367323673336734367353673636737367383673936740367413674236743367443674536746367473674836749367503675136752367533675436755367563675736758367593676036761367623676336764367653676636767367683676936770367713677236773367743677536776367773677836779367803678136782367833678436785367863678736788367893679036791367923679336794367953679636797367983679936800368013680236803368043680536806368073680836809368103681136812368133681436815368163681736818368193682036821368223682336824368253682636827368283682936830368313683236833368343683536836368373683836839368403684136842368433684436845368463684736848368493685036851368523685336854368553685636857368583685936860368613686236863368643686536866368673686836869368703687136872368733687436875368763687736878368793688036881368823688336884368853688636887368883688936890368913689236893368943689536896368973689836899369003690136902369033690436905369063690736908369093691036911369123691336914369153691636917369183691936920369213692236923369243692536926369273692836929369303693136932369333693436935369363693736938369393694036941369423694336944369453694636947369483694936950369513695236953369543695536956369573695836959369603696136962369633696436965369663696736968369693697036971369723697336974369753697636977369783697936980369813698236983369843698536986369873698836989369903699136992369933699436995369963699736998369993700037001370023700337004370053700637007370083700937010370113701237013370143701537016370173701837019370203702137022370233702437025370263702737028370293703037031370323703337034370353703637037370383703937040370413704237043370443704537046370473704837049370503705137052370533705437055370563705737058370593706037061370623706337064370653706637067370683706937070370713707237073370743707537076370773707837079370803708137082370833708437085370863708737088370893709037091370923709337094370953709637097370983709937100371013710237103371043710537106371073710837109371103711137112371133711437115371163711737118371193712037121371223712337124371253712637127371283712937130371313713237133371343713537136371373713837139371403714137142371433714437145371463714737148371493715037151371523715337154371553715637157371583715937160371613716237163371643716537166371673716837169371703717137172371733717437175371763717737178371793718037181371823718337184371853718637187371883718937190371913719237193371943719537196371973719837199372003720137202372033720437205372063720737208372093721037211372123721337214372153721637217372183721937220372213722237223372243722537226372273722837229372303723137232372333723437235372363723737238372393724037241372423724337244372453724637247372483724937250372513725237253372543725537256372573725837259372603726137262372633726437265372663726737268372693727037271372723727337274372753727637277372783727937280372813728237283372843728537286372873728837289372903729137292372933729437295372963729737298372993730037301373023730337304373053730637307373083730937310373113731237313373143731537316373173731837319373203732137322373233732437325373263732737328373293733037331373323733337334373353733637337373383733937340373413734237343373443734537346373473734837349373503735137352373533735437355373563735737358373593736037361373623736337364373653736637367373683736937370373713737237373373743737537376373773737837379373803738137382373833738437385373863738737388373893739037391373923739337394373953739637397373983739937400374013740237403374043740537406374073740837409374103741137412374133741437415374163741737418374193742037421374223742337424374253742637427374283742937430374313743237433374343743537436374373743837439374403744137442374433744437445374463744737448374493745037451374523745337454374553745637457374583745937460374613746237463374643746537466374673746837469374703747137472374733747437475374763747737478374793748037481374823748337484374853748637487374883748937490374913749237493374943749537496374973749837499375003750137502375033750437505375063750737508375093751037511375123751337514375153751637517375183751937520375213752237523375243752537526375273752837529375303753137532375333753437535375363753737538375393754037541375423754337544375453754637547375483754937550375513755237553375543755537556375573755837559375603756137562375633756437565375663756737568375693757037571375723757337574375753757637577375783757937580375813758237583375843758537586375873758837589375903759137592375933759437595375963759737598375993760037601376023760337604376053760637607376083760937610376113761237613376143761537616376173761837619376203762137622376233762437625376263762737628376293763037631376323763337634376353763637637376383763937640376413764237643376443764537646376473764837649376503765137652376533765437655376563765737658376593766037661376623766337664376653766637667376683766937670376713767237673376743767537676376773767837679376803768137682376833768437685376863768737688376893769037691376923769337694376953769637697376983769937700377013770237703377043770537706377073770837709377103771137712377133771437715377163771737718377193772037721377223772337724377253772637727377283772937730377313773237733377343773537736377373773837739377403774137742377433774437745377463774737748377493775037751377523775337754377553775637757377583775937760377613776237763377643776537766377673776837769377703777137772377733777437775377763777737778377793778037781377823778337784377853778637787377883778937790377913779237793377943779537796377973779837799378003780137802378033780437805378063780737808378093781037811378123781337814378153781637817378183781937820378213782237823378243782537826378273782837829378303783137832378333783437835378363783737838378393784037841378423784337844378453784637847378483784937850378513785237853378543785537856378573785837859378603786137862378633786437865378663786737868378693787037871378723787337874378753787637877378783787937880378813788237883378843788537886378873788837889378903789137892378933789437895378963789737898378993790037901379023790337904379053790637907379083790937910379113791237913379143791537916379173791837919379203792137922379233792437925379263792737928379293793037931379323793337934379353793637937379383793937940379413794237943379443794537946379473794837949379503795137952379533795437955379563795737958379593796037961379623796337964379653796637967379683796937970379713797237973379743797537976379773797837979379803798137982379833798437985379863798737988379893799037991379923799337994379953799637997379983799938000380013800238003380043800538006380073800838009380103801138012380133801438015380163801738018380193802038021380223802338024380253802638027380283802938030380313803238033380343803538036380373803838039380403804138042380433804438045380463804738048380493805038051380523805338054380553805638057380583805938060380613806238063380643806538066380673806838069380703807138072380733807438075380763807738078380793808038081380823808338084380853808638087380883808938090380913809238093380943809538096380973809838099381003810138102381033810438105381063810738108381093811038111381123811338114381153811638117381183811938120381213812238123381243812538126381273812838129381303813138132381333813438135381363813738138381393814038141381423814338144381453814638147381483814938150381513815238153381543815538156381573815838159381603816138162381633816438165381663816738168381693817038171381723817338174381753817638177381783817938180381813818238183381843818538186381873818838189381903819138192381933819438195381963819738198381993820038201382023820338204382053820638207382083820938210382113821238213382143821538216382173821838219382203822138222382233822438225382263822738228382293823038231382323823338234382353823638237382383823938240382413824238243382443824538246382473824838249382503825138252382533825438255382563825738258382593826038261382623826338264382653826638267382683826938270382713827238273382743827538276382773827838279382803828138282382833828438285382863828738288382893829038291382923829338294382953829638297382983829938300383013830238303383043830538306383073830838309383103831138312383133831438315383163831738318383193832038321383223832338324383253832638327383283832938330383313833238333383343833538336383373833838339383403834138342383433834438345383463834738348383493835038351383523835338354383553835638357383583835938360383613836238363383643836538366383673836838369383703837138372383733837438375383763837738378383793838038381383823838338384383853838638387383883838938390383913839238393383943839538396383973839838399384003840138402384033840438405384063840738408384093841038411384123841338414384153841638417384183841938420384213842238423384243842538426384273842838429384303843138432384333843438435384363843738438384393844038441384423844338444384453844638447384483844938450384513845238453384543845538456384573845838459384603846138462384633846438465384663846738468384693847038471384723847338474384753847638477384783847938480384813848238483384843848538486384873848838489384903849138492384933849438495384963849738498384993850038501385023850338504385053850638507385083850938510385113851238513385143851538516385173851838519385203852138522385233852438525385263852738528385293853038531385323853338534385353853638537385383853938540385413854238543385443854538546385473854838549385503855138552385533855438555385563855738558385593856038561385623856338564385653856638567385683856938570385713857238573385743857538576385773857838579385803858138582385833858438585385863858738588385893859038591385923859338594385953859638597385983859938600386013860238603386043860538606386073860838609386103861138612386133861438615386163861738618386193862038621386223862338624386253862638627386283862938630386313863238633386343863538636386373863838639386403864138642386433864438645386463864738648386493865038651386523865338654386553865638657386583865938660386613866238663386643866538666386673866838669386703867138672386733867438675386763867738678386793868038681386823868338684386853868638687386883868938690386913869238693386943869538696386973869838699387003870138702387033870438705387063870738708387093871038711387123871338714387153871638717387183871938720387213872238723387243872538726387273872838729387303873138732387333873438735387363873738738387393874038741387423874338744387453874638747387483874938750387513875238753387543875538756387573875838759387603876138762387633876438765387663876738768387693877038771387723877338774387753877638777387783877938780387813878238783387843878538786387873878838789387903879138792387933879438795387963879738798387993880038801388023880338804388053880638807388083880938810388113881238813388143881538816388173881838819388203882138822388233882438825388263882738828388293883038831388323883338834388353883638837388383883938840388413884238843388443884538846388473884838849388503885138852388533885438855388563885738858388593886038861388623886338864388653886638867388683886938870388713887238873388743887538876388773887838879388803888138882388833888438885388863888738888388893889038891388923889338894388953889638897388983889938900389013890238903389043890538906389073890838909389103891138912389133891438915389163891738918389193892038921389223892338924389253892638927389283892938930389313893238933389343893538936389373893838939389403894138942389433894438945389463894738948389493895038951389523895338954389553895638957389583895938960389613896238963389643896538966389673896838969389703897138972389733897438975389763897738978389793898038981389823898338984389853898638987389883898938990389913899238993389943899538996389973899838999390003900139002390033900439005390063900739008390093901039011390123901339014390153901639017390183901939020390213902239023390243902539026390273902839029390303903139032390333903439035390363903739038390393904039041390423904339044390453904639047390483904939050390513905239053390543905539056390573905839059390603906139062390633906439065390663906739068390693907039071390723907339074390753907639077390783907939080390813908239083390843908539086390873908839089390903909139092390933909439095390963909739098390993910039101391023910339104391053910639107391083910939110391113911239113391143911539116391173911839119391203912139122391233912439125391263912739128391293913039131391323913339134391353913639137391383913939140391413914239143391443914539146391473914839149391503915139152391533915439155391563915739158391593916039161391623916339164391653916639167391683916939170391713917239173391743917539176391773917839179391803918139182391833918439185391863918739188391893919039191391923919339194391953919639197391983919939200392013920239203392043920539206392073920839209392103921139212392133921439215392163921739218392193922039221392223922339224392253922639227392283922939230392313923239233392343923539236392373923839239392403924139242392433924439245392463924739248392493925039251392523925339254392553925639257392583925939260392613926239263392643926539266392673926839269392703927139272392733927439275392763927739278392793928039281392823928339284392853928639287392883928939290392913929239293392943929539296392973929839299393003930139302393033930439305393063930739308393093931039311393123931339314393153931639317393183931939320393213932239323393243932539326393273932839329393303933139332393333933439335393363933739338393393934039341393423934339344393453934639347393483934939350393513935239353393543935539356393573935839359393603936139362393633936439365393663936739368393693937039371393723937339374393753937639377393783937939380393813938239383393843938539386393873938839389393903939139392393933939439395393963939739398393993940039401394023940339404394053940639407394083940939410394113941239413394143941539416394173941839419394203942139422394233942439425394263942739428394293943039431394323943339434394353943639437394383943939440394413944239443394443944539446394473944839449394503945139452394533945439455394563945739458394593946039461394623946339464394653946639467394683946939470394713947239473394743947539476394773947839479394803948139482394833948439485394863948739488394893949039491394923949339494394953949639497394983949939500395013950239503395043950539506395073950839509395103951139512395133951439515395163951739518395193952039521395223952339524395253952639527395283952939530395313953239533395343953539536395373953839539395403954139542395433954439545395463954739548395493955039551395523955339554395553955639557395583955939560395613956239563395643956539566395673956839569395703957139572395733957439575395763957739578395793958039581395823958339584395853958639587395883958939590395913959239593395943959539596395973959839599396003960139602396033960439605396063960739608396093961039611396123961339614396153961639617396183961939620396213962239623396243962539626396273962839629396303963139632396333963439635396363963739638396393964039641396423964339644396453964639647396483964939650396513965239653396543965539656396573965839659396603966139662396633966439665396663966739668396693967039671396723967339674396753967639677396783967939680396813968239683396843968539686396873968839689396903969139692396933969439695396963969739698396993970039701397023970339704397053970639707397083970939710397113971239713397143971539716397173971839719397203972139722397233972439725397263972739728397293973039731397323973339734397353973639737397383973939740397413974239743397443974539746397473974839749397503975139752397533975439755397563975739758397593976039761397623976339764397653976639767397683976939770397713977239773397743977539776397773977839779397803978139782397833978439785397863978739788397893979039791397923979339794397953979639797397983979939800398013980239803398043980539806398073980839809398103981139812398133981439815398163981739818398193982039821398223982339824398253982639827398283982939830398313983239833398343983539836398373983839839398403984139842398433984439845398463984739848398493985039851398523985339854398553985639857398583985939860398613986239863398643986539866398673986839869398703987139872398733987439875398763987739878398793988039881398823988339884398853988639887398883988939890398913989239893398943989539896398973989839899399003990139902399033990439905399063990739908399093991039911399123991339914399153991639917399183991939920399213992239923399243992539926399273992839929399303993139932399333993439935399363993739938399393994039941399423994339944399453994639947399483994939950399513995239953399543995539956399573995839959399603996139962399633996439965399663996739968399693997039971399723997339974399753997639977399783997939980399813998239983399843998539986399873998839989399903999139992399933999439995399963999739998399994000040001400024000340004400054000640007400084000940010400114001240013400144001540016400174001840019400204002140022400234002440025400264002740028400294003040031400324003340034400354003640037400384003940040400414004240043400444004540046400474004840049400504005140052400534005440055400564005740058400594006040061400624006340064400654006640067400684006940070400714007240073400744007540076400774007840079400804008140082400834008440085400864008740088400894009040091400924009340094400954009640097400984009940100401014010240103401044010540106401074010840109401104011140112401134011440115401164011740118401194012040121401224012340124401254012640127401284012940130401314013240133401344013540136401374013840139401404014140142401434014440145401464014740148401494015040151401524015340154401554015640157401584015940160401614016240163401644016540166401674016840169401704017140172401734017440175401764017740178401794018040181401824018340184401854018640187401884018940190401914019240193401944019540196401974019840199402004020140202402034020440205402064020740208402094021040211402124021340214402154021640217402184021940220402214022240223402244022540226402274022840229402304023140232402334023440235402364023740238402394024040241402424024340244402454024640247402484024940250402514025240253402544025540256402574025840259402604026140262402634026440265402664026740268402694027040271402724027340274402754027640277402784027940280402814028240283402844028540286402874028840289402904029140292402934029440295402964029740298402994030040301403024030340304403054030640307403084030940310403114031240313403144031540316403174031840319403204032140322403234032440325403264032740328403294033040331403324033340334403354033640337403384033940340403414034240343403444034540346403474034840349403504035140352403534035440355403564035740358403594036040361403624036340364403654036640367403684036940370403714037240373403744037540376403774037840379403804038140382403834038440385403864038740388403894039040391403924039340394403954039640397403984039940400404014040240403404044040540406404074040840409404104041140412404134041440415404164041740418404194042040421404224042340424404254042640427404284042940430404314043240433404344043540436404374043840439404404044140442404434044440445404464044740448404494045040451404524045340454404554045640457404584045940460404614046240463404644046540466404674046840469404704047140472404734047440475404764047740478404794048040481404824048340484404854048640487404884048940490404914049240493404944049540496404974049840499405004050140502405034050440505405064050740508405094051040511405124051340514405154051640517405184051940520405214052240523405244052540526405274052840529405304053140532405334053440535405364053740538405394054040541405424054340544405454054640547405484054940550405514055240553405544055540556405574055840559405604056140562405634056440565405664056740568405694057040571405724057340574405754057640577405784057940580405814058240583405844058540586405874058840589405904059140592405934059440595405964059740598405994060040601406024060340604406054060640607406084060940610406114061240613406144061540616406174061840619406204062140622406234062440625406264062740628406294063040631406324063340634406354063640637406384063940640406414064240643406444064540646406474064840649406504065140652406534065440655406564065740658406594066040661406624066340664406654066640667406684066940670406714067240673406744067540676406774067840679406804068140682406834068440685406864068740688406894069040691406924069340694406954069640697406984069940700407014070240703407044070540706407074070840709407104071140712407134071440715407164071740718407194072040721407224072340724407254072640727407284072940730407314073240733407344073540736407374073840739407404074140742407434074440745407464074740748407494075040751407524075340754407554075640757407584075940760407614076240763407644076540766407674076840769407704077140772407734077440775407764077740778407794078040781407824078340784407854078640787407884078940790407914079240793407944079540796407974079840799408004080140802408034080440805408064080740808408094081040811408124081340814408154081640817408184081940820408214082240823408244082540826408274082840829408304083140832408334083440835408364083740838408394084040841408424084340844408454084640847 |
- <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
- <!-- Generated by the JDiff Javadoc doclet -->
- <!-- (http://www.jdiff.org) -->
- <!-- on Tue Oct 29 19:50:43 PDT 2019 -->
- <api
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:noNamespaceSchemaLocation='api.xsd'
- name="Apache Hadoop Common 2.10.0"
- jdversion="1.0.9">
- <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /home/jhung/hadoop/hadoop-common-project/hadoop-common/target/hadoop-annotations.jar:/home/jhung/hadoop/hadoop-common-project/hadoop-common/target/jdiff.jar -verbose -classpath /home/jhung/hadoop/hadoop-common-project/hadoop-common/target/classes:/home/jhung/hadoop/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-2.10.0.jar:/export/apps/jdk/JDK-1_7_0_51/lib/tools.jar:/home/jhung/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/home/jhung/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/home/jhung/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/home/jhung/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/home/jhung/.m2/repository/org/apache/httpcomponents/httpclient/4.5.2/httpclient-4.5.2.jar:/home/jhung/.m2/repository/org/apache/httpcomponents/httpcore/4.4.4/httpcore-4.4.4.jar:/home/jhung/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/home/jhung/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/home/jhung/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/home/jhung/.m2/repository/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/home/jhung/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/home/jhung/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/home/jhung/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/home/jhung/.m2/repository/org/mortbay/jetty/jetty-sslengine/6.1.26/jetty-sslengine-6.1.26.jar:/home/jhung/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/home/jhung/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/home/jhung/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/home/jhung/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/home/jhung/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/home/jhung/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/home/jhung/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/home/jhung/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/home/jhung/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/home/jhung/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/home/jhung/.m2/repository/asm/asm/3.2/asm-3.2.jar:/home/jhung/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/home/jhung/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/home/jhung/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/home/jhung/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/home/jhung/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/home/jhung/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/home/jhung/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/home/jhung/.m2/repository/commons-beanutils/commons-beanutils/1.9.4/commons-beanutils-1.9.4.jar:/home/jhung/.m2/repository/org/apache/commons/commons-lang3/3.4/commons-lang3-3.4.jar:/home/jhung/.m2/repository/org/slf4j/slf4j-api/1.7.25/slf4j-api-1.7.25.jar:/home/jhung/.m2/repository/org/slf4j/slf4j-log4j12/1.7.25/slf4j-log4j12-1.7.25.jar:/home/jhung/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/home/jhung/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/home/jhung/.m2/repository/org/apache/avro/avro/1.7.7/avro-1.7.7.jar:/home/jhung/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/home/jhung/.m2/repository/org/xerial/snappy/snappy-java/1.0.5/snappy-java-1.0.5.jar:/home/jhung/.m2/repository/org/apache/ant/ant/1.8.1/ant-1.8.1.jar:/home/jhung/.m2/repository/org/apache/ant/ant-launcher/1.8.1/ant-launcher-1.8.1.jar:/home/jhung/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/home/jhung/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/home/jhung/hadoop/hadoop-common-project/hadoop-auth/target/hadoop-auth-2.10.0.jar:/home/jhung/.m2/repository/com/nimbusds/nimbus-jose-jwt/4.41.1/nimbus-jose-jwt-4.41.1.jar:/home/jhung/.m2/repository/com/github/stephenc/jcip/jcip-annotations/1.0-1/jcip-annotations-1.0-1.jar:/home/jhung/.m2/repository/net/minidev/json-smart/1.3.1/json-smart-1.3.1.jar:/home/jhung/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/home/jhung/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/home/jhung/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/home/jhung/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/home/jhung/.m2/repository/org/apache/curator/curator-framework/2.7.1/curator-framework-2.7.1.jar:/home/jhung/.m2/repository/com/jcraft/jsch/0.1.54/jsch-0.1.54.jar:/home/jhung/.m2/repository/org/apache/curator/curator-client/2.7.1/curator-client-2.7.1.jar:/home/jhung/.m2/repository/org/apache/curator/curator-recipes/2.7.1/curator-recipes-2.7.1.jar:/home/jhung/.m2/repository/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/home/jhung/.m2/repository/org/apache/htrace/htrace-core4/4.1.0-incubating/htrace-core4-4.1.0-incubating.jar:/home/jhung/.m2/repository/org/apache/zookeeper/zookeeper/3.4.9/zookeeper-3.4.9.jar:/home/jhung/.m2/repository/io/netty/netty/3.10.6.Final/netty-3.10.6.Final.jar:/home/jhung/.m2/repository/org/apache/commons/commons-compress/1.19/commons-compress-1.19.jar:/home/jhung/.m2/repository/org/codehaus/woodstox/stax2-api/3.1.4/stax2-api-3.1.4.jar:/home/jhung/.m2/repository/com/fasterxml/woodstox/woodstox-core/5.0.3/woodstox-core-5.0.3.jar -sourcepath /home/jhung/hadoop/hadoop-common-project/hadoop-common/src/main/java -apidir /home/jhung/hadoop/hadoop-common-project/hadoop-common/target/site/jdiff/xml -apiname Apache Hadoop Common 2.10.0 -->
- <package name="org.apache.hadoop">
- <!-- start class org.apache.hadoop.HadoopIllegalArgumentException -->
- <class name="HadoopIllegalArgumentException" extends="java.lang.IllegalArgumentException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HadoopIllegalArgumentException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs exception with the specified detail message.
- @param message detailed message.]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Indicates that a method has been passed illegal or invalid argument. This
- exception is thrown instead of IllegalArgumentException to differentiate the
- exception thrown in Hadoop implementation from the one thrown in JDK.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.HadoopIllegalArgumentException -->
- </package>
- <package name="org.apache.hadoop.conf">
- <!-- start interface org.apache.hadoop.conf.Configurable -->
- <interface name="Configurable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Set the configuration to be used by this object.]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the configuration used by this object.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Something that may be configured with a {@link Configuration}.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.conf.Configurable -->
- <!-- start class org.apache.hadoop.conf.Configuration -->
- <class name="Configuration" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Iterable"/>
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A new configuration.]]>
- </doc>
- </constructor>
- <constructor name="Configuration" type="boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A new configuration where the behavior of reading from the default
- resources can be turned off.
-
- If the parameter {@code loadDefaults} is false, the new instance
- will not load resources from the default files.
- @param loadDefaults specifies whether to load from the default files]]>
- </doc>
- </constructor>
- <constructor name="Configuration" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A new configuration with the same settings cloned from another.
-
- @param other the configuration from which to clone settings.]]>
- </doc>
- </constructor>
- <method name="addDeprecations"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="deltas" type="org.apache.hadoop.conf.Configuration.DeprecationDelta[]"/>
- <doc>
- <![CDATA[Adds a set of deprecated keys to the global deprecations.
- This method is lockless. It works by means of creating a new
- DeprecationContext based on the old one, and then atomically swapping in
- the new context. If someone else updated the context in between us reading
- the old context and swapping in the new one, we try again until we win the
- race.
- @param deltas The deprecations to add.]]>
- </doc>
- </method>
- <method name="addDeprecation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="use {@link #addDeprecation(String key, String newKey,
- String customMessage)} instead">
- <param name="key" type="java.lang.String"/>
- <param name="newKeys" type="java.lang.String[]"/>
- <param name="customMessage" type="java.lang.String"/>
- <doc>
- <![CDATA[Adds the deprecated key to the global deprecation map.
- It does not override any existing entries in the deprecation map.
- This is to be used only by the developers in order to add deprecation of
- keys, and attempts to call this method after loading resources once,
- would lead to <tt>UnsupportedOperationException</tt>
-
- If a key is deprecated in favor of multiple keys, they are all treated as
- aliases of each other, and setting any one of them resets all the others
- to the new value.
- If you have multiple deprecation entries to add, it is more efficient to
- use #addDeprecations(DeprecationDelta[] deltas) instead.
-
- @param key
- @param newKeys
- @param customMessage
- @deprecated use {@link #addDeprecation(String key, String newKey,
- String customMessage)} instead]]>
- </doc>
- </method>
- <method name="addDeprecation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="newKey" type="java.lang.String"/>
- <param name="customMessage" type="java.lang.String"/>
- <doc>
- <![CDATA[Adds the deprecated key to the global deprecation map.
- It does not override any existing entries in the deprecation map.
- This is to be used only by the developers in order to add deprecation of
- keys, and attempts to call this method after loading resources once,
- would lead to <tt>UnsupportedOperationException</tt>
-
- If you have multiple deprecation entries to add, it is more efficient to
- use #addDeprecations(DeprecationDelta[] deltas) instead.
- @param key
- @param newKey
- @param customMessage]]>
- </doc>
- </method>
- <method name="addDeprecation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="use {@link #addDeprecation(String key, String newKey)} instead">
- <param name="key" type="java.lang.String"/>
- <param name="newKeys" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Adds the deprecated key to the global deprecation map when no custom
- message is provided.
- It does not override any existing entries in the deprecation map.
- This is to be used only by the developers in order to add deprecation of
- keys, and attempts to call this method after loading resources once,
- would lead to <tt>UnsupportedOperationException</tt>
-
- If a key is deprecated in favor of multiple keys, they are all treated as
- aliases of each other, and setting any one of them resets all the others
- to the new value.
-
- If you have multiple deprecation entries to add, it is more efficient to
- use #addDeprecations(DeprecationDelta[] deltas) instead.
- @param key Key that is to be deprecated
- @param newKeys list of keys that take up the values of deprecated key
- @deprecated use {@link #addDeprecation(String key, String newKey)} instead]]>
- </doc>
- </method>
- <method name="addDeprecation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="newKey" type="java.lang.String"/>
- <doc>
- <![CDATA[Adds the deprecated key to the global deprecation map when no custom
- message is provided.
- It does not override any existing entries in the deprecation map.
- This is to be used only by the developers in order to add deprecation of
- keys, and attempts to call this method after loading resources once,
- would lead to <tt>UnsupportedOperationException</tt>
-
- If you have multiple deprecation entries to add, it is more efficient to
- use #addDeprecations(DeprecationDelta[] deltas) instead.
- @param key Key that is to be deprecated
- @param newKey key that takes up the value of deprecated key]]>
- </doc>
- </method>
- <method name="isDeprecated" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <doc>
- <![CDATA[checks whether the given <code>key</code> is deprecated.
-
- @param key the parameter which is to be checked for deprecation
- @return <code>true</code> if the key is deprecated and
- <code>false</code> otherwise.]]>
- </doc>
- </method>
- <method name="setDeprecatedProperties"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Sets all deprecated properties that are not currently set but have a
- corresponding new property that is set. Useful for iterating the
- properties when all deprecated properties for currently set properties
- need to be present.]]>
- </doc>
- </method>
- <method name="reloadExistingConfigurations"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reload existing configuration instances.]]>
- </doc>
- </method>
- <method name="addDefaultResource"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a default resource. Resources are loaded in the order of the resources
- added.
- @param name file name. File should be present in the classpath.]]>
- </doc>
- </method>
- <method name="setRestrictSystemPropertiesDefault"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="boolean"/>
- </method>
- <method name="setRestrictSystemProperties"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="boolean"/>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a configuration resource.
-
- The properties of this resource will override properties of previously
- added resources, unless they were marked <a href="#Final">final</a>.
-
- @param name resource to be added, the classpath is examined for a file
- with that name.]]>
- </doc>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="restrictedParser" type="boolean"/>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <doc>
- <![CDATA[Add a configuration resource.
-
- The properties of this resource will override properties of previously
- added resources, unless they were marked <a href="#Final">final</a>.
-
- @param url url of the resource to be added, the local filesystem is
- examined directly to find the resource, without referring to
- the classpath.]]>
- </doc>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="restrictedParser" type="boolean"/>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Add a configuration resource.
-
- The properties of this resource will override properties of previously
- added resources, unless they were marked <a href="#Final">final</a>.
-
- @param file file-path of resource to be added, the local filesystem is
- examined directly to find the resource, without referring to
- the classpath.]]>
- </doc>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="restrictedParser" type="boolean"/>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <doc>
- <![CDATA[Add a configuration resource.
-
- The properties of this resource will override properties of previously
- added resources, unless they were marked <a href="#Final">final</a>.
-
- WARNING: The contents of the InputStream will be cached, by this method.
- So use this sparingly because it does increase the memory consumption.
-
- @param in InputStream to deserialize the object from. In will be read from
- when a get or set is called next. After it is read the stream will be
- closed.]]>
- </doc>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="restrictedParser" type="boolean"/>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a configuration resource.
-
- The properties of this resource will override properties of previously
- added resources, unless they were marked <a href="#Final">final</a>.
-
- @param in InputStream to deserialize the object from.
- @param name the name of the resource because InputStream.toString is not
- very descriptive some times.]]>
- </doc>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="name" type="java.lang.String"/>
- <param name="restrictedParser" type="boolean"/>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Add a configuration resource.
- The properties of this resource will override properties of previously
- added resources, unless they were marked <a href="#Final">final</a>.
- @param conf Configuration object from which to load properties]]>
- </doc>
- </method>
- <method name="reloadConfiguration"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reload configuration from previously added resources.
- This method will clear all the configuration read from the added
- resources, and final parameters. This will make the resources to
- be read again before accessing the values. Values that are added
- via set methods will overlay values read from the resources.]]>
- </doc>
- </method>
- <method name="get" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property, <code>null</code> if
- no such property exists. If the key is deprecated, it returns the value of
- the first key which replaces the deprecated key and is not null.
-
- Values are processed for <a href="#VariableExpansion">variable expansion</a>
- before being returned.
-
- @param name the property name, will be trimmed before get value.
- @return the value of the <code>name</code> or its replacing property,
- or null if no such property exists.]]>
- </doc>
- </method>
- <method name="setAllowNullValueProperties"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="boolean"/>
- <doc>
- <![CDATA[Set Configuration to allow keys without values during setup. Intended
- for use during testing.
- @param val If true, will allow Configuration to store keys without values]]>
- </doc>
- </method>
- <method name="setRestrictSystemProps"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="boolean"/>
- </method>
- <method name="onlyKeyExists" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Return existence of the <code>name</code> property, but only for
- names which have no valid value, usually non-existent or commented
- out in XML.
- @param name the property name
- @return true if the property <code>name</code> exists without value]]>
- </doc>
- </method>
- <method name="getTrimmed" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a trimmed <code>String</code>,
- <code>null</code> if no such property exists.
- If the key is deprecated, it returns the value of
- the first key which replaces the deprecated key and is not null
-
- Values are processed for <a href="#VariableExpansion">variable expansion</a>
- before being returned.
-
- @param name the property name.
- @return the value of the <code>name</code> or its replacing property,
- or null if no such property exists.]]>
- </doc>
- </method>
- <method name="getTrimmed" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a trimmed <code>String</code>,
- <code>defaultValue</code> if no such property exists.
- See @{Configuration#getTrimmed} for more details.
-
- @param name the property name.
- @param defaultValue the property default value.
- @return the value of the <code>name</code> or defaultValue
- if it is not set.]]>
- </doc>
- </method>
- <method name="getRaw" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property, without doing
- <a href="#VariableExpansion">variable expansion</a>.If the key is
- deprecated, it returns the value of the first key which replaces
- the deprecated key and is not null.
-
- @param name the property name.
- @return the value of the <code>name</code> property or
- its replacing property and null if no such property exists.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>value</code> of the <code>name</code> property. If
- <code>name</code> is deprecated or there is a deprecated name associated to it,
- it sets the value to both names. Name will be trimmed before put into
- configuration.
-
- @param name property name.
- @param value property value.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <param name="source" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>value</code> of the <code>name</code> property. If
- <code>name</code> is deprecated, it also sets the <code>value</code> to
- the keys that replace the deprecated key. Name will be trimmed before put
- into configuration.
- @param name property name.
- @param value property value.
- @param source the place that this configuration value came from
- (For debugging).
- @throws IllegalArgumentException when the value or name is null.]]>
- </doc>
- </method>
- <method name="unset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Unset a previously set property.]]>
- </doc>
- </method>
- <method name="setIfUnset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets a property if it is currently unset.
- @param name the property name
- @param value the new value]]>
- </doc>
- </method>
- <method name="get" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code>. If the key is deprecated,
- it returns the value of the first key which replaces the deprecated key
- and is not null.
- If no such property exists,
- then <code>defaultValue</code> is returned.
-
- @param name property name, will be trimmed before get value.
- @param defaultValue default value.
- @return property value, or <code>defaultValue</code> if the property
- doesn't exist.]]>
- </doc>
- </method>
- <method name="getInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="int"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as an <code>int</code>.
-
- If no such property exists, the provided default value is returned,
- or if the specified value is not a valid <code>int</code>,
- then an error is thrown.
-
- @param name property name.
- @param defaultValue default value.
- @throws NumberFormatException when the value is invalid
- @return property value as an <code>int</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="getInts" return="int[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a set of comma-delimited
- <code>int</code> values.
-
- If no such property exists, an empty array is returned.
-
- @param name property name
- @return property value interpreted as an array of comma-delimited
- <code>int</code> values]]>
- </doc>
- </method>
- <method name="setInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to an <code>int</code>.
-
- @param name property name.
- @param value <code>int</code> value of the property.]]>
- </doc>
- </method>
- <method name="getLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="long"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>long</code>.
- If no such property exists, the provided default value is returned,
- or if the specified value is not a valid <code>long</code>,
- then an error is thrown.
-
- @param name property name.
- @param defaultValue default value.
- @throws NumberFormatException when the value is invalid
- @return property value as a <code>long</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="getLongBytes" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="long"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>long</code> or
- human readable format. If no such property exists, the provided default
- value is returned, or if the specified value is not a valid
- <code>long</code> or human readable format, then an error is thrown. You
- can use the following suffix (case insensitive): k(kilo), m(mega), g(giga),
- t(tera), p(peta), e(exa)
- @param name property name.
- @param defaultValue default value.
- @throws NumberFormatException when the value is invalid
- @return property value as a <code>long</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="setLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to a <code>long</code>.
-
- @param name property name.
- @param value <code>long</code> value of the property.]]>
- </doc>
- </method>
- <method name="getFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="float"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>float</code>.
- If no such property exists, the provided default value is returned,
- or if the specified value is not a valid <code>float</code>,
- then an error is thrown.
- @param name property name.
- @param defaultValue default value.
- @throws NumberFormatException when the value is invalid
- @return property value as a <code>float</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="setFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="float"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to a <code>float</code>.
-
- @param name property name.
- @param value property value.]]>
- </doc>
- </method>
- <method name="getDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="double"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>double</code>.
- If no such property exists, the provided default value is returned,
- or if the specified value is not a valid <code>double</code>,
- then an error is thrown.
- @param name property name.
- @param defaultValue default value.
- @throws NumberFormatException when the value is invalid
- @return property value as a <code>double</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="setDouble"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="double"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to a <code>double</code>.
-
- @param name property name.
- @param value property value.]]>
- </doc>
- </method>
- <method name="getBoolean" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="boolean"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>boolean</code>.
- If no such property is specified, or if the specified value is not a valid
- <code>boolean</code>, then <code>defaultValue</code> is returned.
-
- @param name property name.
- @param defaultValue default value.
- @return property value as a <code>boolean</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="setBoolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to a <code>boolean</code>.
-
- @param name property name.
- @param value <code>boolean</code> value of the property.]]>
- </doc>
- </method>
- <method name="setBooleanIfUnset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Set the given property, if it is currently unset.
- @param name property name
- @param value new value]]>
- </doc>
- </method>
- <method name="setEnum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="T"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to the given type. This
- is equivalent to <code>set(<name>, value.toString())</code>.
- @param name property name
- @param value new value]]>
- </doc>
- </method>
- <method name="getEnum" return="T"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="T"/>
- <doc>
- <![CDATA[Return value matching this enumerated type.
- Note that the returned value is trimmed by this method.
- @param name Property name
- @param defaultValue Value returned if no mapping exists
- @throws IllegalArgumentException If mapping is illegal for the type
- provided]]>
- </doc>
- </method>
- <method name="setTimeDuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="long"/>
- <param name="unit" type="java.util.concurrent.TimeUnit"/>
- <doc>
- <![CDATA[Set the value of <code>name</code> to the given time duration. This
- is equivalent to <code>set(<name>, value + <time suffix>)</code>.
- @param name Property name
- @param value Time duration
- @param unit Unit of time]]>
- </doc>
- </method>
- <method name="getTimeDuration" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="long"/>
- <param name="unit" type="java.util.concurrent.TimeUnit"/>
- <doc>
- <![CDATA[Return time duration in the given time unit. Valid units are encoded in
- properties as suffixes: nanoseconds (ns), microseconds (us), milliseconds
- (ms), seconds (s), minutes (m), hours (h), and days (d).
- @param name Property name
- @param defaultValue Value returned if no mapping exists.
- @param unit Unit to convert the stored property, if it exists.
- @throws NumberFormatException If the property stripped of its unit is not
- a number]]>
- </doc>
- </method>
- <method name="getTimeDurations" return="long[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="unit" type="java.util.concurrent.TimeUnit"/>
- </method>
- <method name="getPattern" return="java.util.regex.Pattern"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.util.regex.Pattern"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>Pattern</code>.
- If no such property is specified, or if the specified value is not a valid
- <code>Pattern</code>, then <code>DefaultValue</code> is returned.
- Note that the returned value is NOT trimmed by this method.
- @param name property name
- @param defaultValue default value
- @return property value as a compiled Pattern, or defaultValue]]>
- </doc>
- </method>
- <method name="setPattern"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="pattern" type="java.util.regex.Pattern"/>
- <doc>
- <![CDATA[Set the given property to <code>Pattern</code>.
- If the pattern is passed as null, sets the empty pattern which results in
- further calls to getPattern(...) returning the default value.
- @param name property name
- @param pattern new value]]>
- </doc>
- </method>
- <method name="getPropertySources" return="java.lang.String[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Gets information about why a property was set. Typically this is the
- path to the resource objects (file, URL, etc.) the property came from, but
- it can also indicate that it was set programatically, or because of the
- command line.
- @param name - The property name to get the source of.
- @return null - If the property or its source wasn't found. Otherwise,
- returns a list of the sources of the resource. The older sources are
- the first ones in the list. So for example if a configuration is set from
- the command line, and then written out to a file that is read back in the
- first entry would indicate that it was set from the command line, while
- the second one would indicate the file that the new configuration was read
- in from.]]>
- </doc>
- </method>
- <method name="getRange" return="org.apache.hadoop.conf.Configuration.IntegerRanges"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.String"/>
- <doc>
- <![CDATA[Parse the given attribute as a set of integer ranges
- @param name the attribute name
- @param defaultValue the default value if it is not set
- @return a new set of ranges from the configured value]]>
- </doc>
- </method>
- <method name="getStringCollection" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the comma delimited values of the <code>name</code> property as
- a collection of <code>String</code>s.
- If no such property is specified then empty collection is returned.
- <p>
- This is an optimized version of {@link #getStrings(String)}
-
- @param name property name.
- @return property value as a collection of <code>String</code>s.]]>
- </doc>
- </method>
- <method name="getStrings" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the comma delimited values of the <code>name</code> property as
- an array of <code>String</code>s.
- If no such property is specified then <code>null</code> is returned.
-
- @param name property name.
- @return property value as an array of <code>String</code>s,
- or <code>null</code>.]]>
- </doc>
- </method>
- <method name="getStrings" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Get the comma delimited values of the <code>name</code> property as
- an array of <code>String</code>s.
- If no such property is specified then default value is returned.
-
- @param name property name.
- @param defaultValue The default value
- @return property value as an array of <code>String</code>s,
- or default value.]]>
- </doc>
- </method>
- <method name="getTrimmedStringCollection" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the comma delimited values of the <code>name</code> property as
- a collection of <code>String</code>s, trimmed of the leading and trailing whitespace.
- If no such property is specified then empty <code>Collection</code> is returned.
- @param name property name.
- @return property value as a collection of <code>String</code>s, or empty <code>Collection</code>]]>
- </doc>
- </method>
- <method name="getTrimmedStrings" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the comma delimited values of the <code>name</code> property as
- an array of <code>String</code>s, trimmed of the leading and trailing whitespace.
- If no such property is specified then an empty array is returned.
-
- @param name property name.
- @return property value as an array of trimmed <code>String</code>s,
- or empty array.]]>
- </doc>
- </method>
- <method name="getTrimmedStrings" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Get the comma delimited values of the <code>name</code> property as
- an array of <code>String</code>s, trimmed of the leading and trailing whitespace.
- If no such property is specified then default value is returned.
-
- @param name property name.
- @param defaultValue The default value
- @return property value as an array of trimmed <code>String</code>s,
- or default value.]]>
- </doc>
- </method>
- <method name="setStrings"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="values" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Set the array of string values for the <code>name</code> property as
- as comma delimited values.
-
- @param name property name.
- @param values The values]]>
- </doc>
- </method>
- <method name="getPassword" return="char[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the value for a known password configuration element.
- In order to enable the elimination of clear text passwords in config,
- this method attempts to resolve the property name as an alias through
- the CredentialProvider API and conditionally fallsback to config.
- @param name property name
- @return password]]>
- </doc>
- </method>
- <method name="getPasswordFromCredentialProviders" return="char[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Try and resolve the provided element name as a credential provider
- alias.
- @param name alias of the provisioned credential
- @return password or null if not found
- @throws IOException]]>
- </doc>
- </method>
- <method name="getPasswordFromConfig" return="char[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Fallback to clear text passwords in configuration.
- @param name
- @return clear text password or null]]>
- </doc>
- </method>
- <method name="getSocketAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hostProperty" type="java.lang.String"/>
- <param name="addressProperty" type="java.lang.String"/>
- <param name="defaultAddressValue" type="java.lang.String"/>
- <param name="defaultPort" type="int"/>
- <doc>
- <![CDATA[Get the socket address for <code>hostProperty</code> as a
- <code>InetSocketAddress</code>. If <code>hostProperty</code> is
- <code>null</code>, <code>addressProperty</code> will be used. This
- is useful for cases where we want to differentiate between host
- bind address and address clients should use to establish connection.
- @param hostProperty bind host property name.
- @param addressProperty address property name.
- @param defaultAddressValue the default value
- @param defaultPort the default port
- @return InetSocketAddress]]>
- </doc>
- </method>
- <method name="getSocketAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultAddress" type="java.lang.String"/>
- <param name="defaultPort" type="int"/>
- <doc>
- <![CDATA[Get the socket address for <code>name</code> property as a
- <code>InetSocketAddress</code>.
- @param name property name.
- @param defaultAddress the default value
- @param defaultPort the default port
- @return InetSocketAddress]]>
- </doc>
- </method>
- <method name="setSocketAddr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <doc>
- <![CDATA[Set the socket address for the <code>name</code> property as
- a <code>host:port</code>.]]>
- </doc>
- </method>
- <method name="updateConnectAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hostProperty" type="java.lang.String"/>
- <param name="addressProperty" type="java.lang.String"/>
- <param name="defaultAddressValue" type="java.lang.String"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <doc>
- <![CDATA[Set the socket address a client can use to connect for the
- <code>name</code> property as a <code>host:port</code>. The wildcard
- address is replaced with the local host's address. If the host and address
- properties are configured the host component of the address will be combined
- with the port component of the addr to generate the address. This is to allow
- optional control over which host name is used in multi-home bind-host
- cases where a host can have multiple names
- @param hostProperty the bind-host configuration name
- @param addressProperty the service address configuration name
- @param defaultAddressValue the service default address configuration value
- @param addr InetSocketAddress of the service listener
- @return InetSocketAddress for clients to connect]]>
- </doc>
- </method>
- <method name="updateConnectAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <doc>
- <![CDATA[Set the socket address a client can use to connect for the
- <code>name</code> property as a <code>host:port</code>. The wildcard
- address is replaced with the local host's address.
- @param name property name.
- @param addr InetSocketAddress of a listener to store in the given property
- @return InetSocketAddress for clients to connect]]>
- </doc>
- </method>
- <method name="getClassByName" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <doc>
- <![CDATA[Load a class by name.
-
- @param name the class name.
- @return the class object.
- @throws ClassNotFoundException if the class is not found.]]>
- </doc>
- </method>
- <method name="getClassByNameOrNull" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Load a class by name, returning null rather than throwing an exception
- if it couldn't be loaded. This is to avoid the overhead of creating
- an exception.
-
- @param name the class name
- @return the class object, or null if it could not be found.]]>
- </doc>
- </method>
- <method name="getClasses" return="java.lang.Class[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.Class[]"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property
- as an array of <code>Class</code>.
- The value of the property specifies a list of comma separated class names.
- If no such property is specified, then <code>defaultValue</code> is
- returned.
-
- @param name the property name.
- @param defaultValue default value.
- @return property value as a <code>Class[]</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="getClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>Class</code>.
- If no such property is specified, then <code>defaultValue</code> is
- returned.
-
- @param name the class name.
- @param defaultValue default value.
- @return property value as a <code>Class</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="getClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.Class"/>
- <param name="xface" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>Class</code>
- implementing the interface specified by <code>xface</code>.
-
- If no such property is specified, then <code>defaultValue</code> is
- returned.
-
- An exception is thrown if the returned class does not implement the named
- interface.
-
- @param name the class name.
- @param defaultValue default value.
- @param xface the interface implemented by the named class.
- @return property value as a <code>Class</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="getInstances" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="xface" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>List</code>
- of objects implementing the interface specified by <code>xface</code>.
-
- An exception is thrown if any of the classes does not exist, or if it does
- not implement the named interface.
-
- @param name the property name.
- @param xface the interface implemented by the classes named by
- <code>name</code>.
- @return a <code>List</code> of objects implementing <code>xface</code>.]]>
- </doc>
- </method>
- <method name="setClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="theClass" type="java.lang.Class"/>
- <param name="xface" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to the name of a
- <code>theClass</code> implementing the given interface <code>xface</code>.
-
- An exception is thrown if <code>theClass</code> does not implement the
- interface <code>xface</code>.
-
- @param name property name.
- @param theClass property value.
- @param xface the interface implemented by the named class.]]>
- </doc>
- </method>
- <method name="getLocalPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dirsProp" type="java.lang.String"/>
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a local file under a directory named by <i>dirsProp</i> with
- the given <i>path</i>. If <i>dirsProp</i> contains multiple directories,
- then one is chosen based on <i>path</i>'s hash code. If the selected
- directory does not exist, an attempt is made to create it.
-
- @param dirsProp directory in which to locate the file.
- @param path file-path.
- @return local file under the directory with the given path.]]>
- </doc>
- </method>
- <method name="getFile" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dirsProp" type="java.lang.String"/>
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a local file name under a directory named in <i>dirsProp</i> with
- the given <i>path</i>. If <i>dirsProp</i> contains multiple directories,
- then one is chosen based on <i>path</i>'s hash code. If the selected
- directory does not exist, an attempt is made to create it.
-
- @param dirsProp directory in which to locate the file.
- @param path file-path.
- @return local file under the directory with the given path.]]>
- </doc>
- </method>
- <method name="getResource" return="java.net.URL"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the {@link URL} for the named resource.
-
- @param name resource name.
- @return the url for the named resource.]]>
- </doc>
- </method>
- <method name="getConfResourceAsInputStream" return="java.io.InputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get an input stream attached to the configuration resource with the
- given <code>name</code>.
-
- @param name configuration resource name.
- @return an input stream attached to the resource.]]>
- </doc>
- </method>
- <method name="getConfResourceAsReader" return="java.io.Reader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get a {@link Reader} attached to the configuration resource with the
- given <code>name</code>.
-
- @param name configuration resource name.
- @return a reader attached to the resource.]]>
- </doc>
- </method>
- <method name="getFinalParameters" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the set of parameters marked final.
- @return final parameter set.]]>
- </doc>
- </method>
- <method name="getProps" return="java.util.Properties"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the number of keys in the configuration.
- @return number of keys in the configuration.]]>
- </doc>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clears all keys from the configuration.]]>
- </doc>
- </method>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get an {@link Iterator} to go through the list of <code>String</code>
- key-value pairs in the configuration.
-
- @return an iterator over the entries.]]>
- </doc>
- </method>
- <method name="getPropsWithPrefix" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="confPrefix" type="java.lang.String"/>
- <doc>
- <![CDATA[Constructs a mapping of configuration and includes all properties that
- start with the specified configuration prefix. Property names in the
- mapping are trimmed to remove the configuration prefix.
- @param confPrefix configuration prefix
- @return mapping of configuration properties with prefix stripped]]>
- </doc>
- </method>
- <method name="writeXml"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write out the non-default properties in this configuration to the given
- {@link OutputStream} using UTF-8 encoding.
-
- @param out the output stream to write to.]]>
- </doc>
- </method>
- <method name="writeXml"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.Writer"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeXml"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="propertyName" type="java.lang.String"/>
- <param name="out" type="java.io.Writer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[Write out the non-default properties in this configuration to the
- given {@link Writer}.
- <li>
- When property name is not empty and the property exists in the
- configuration, this method writes the property and its attributes
- to the {@link Writer}.
- </li>
- <p>
- <li>
- When property name is null or empty, this method writes all the
- configuration properties and their attributes to the {@link Writer}.
- </li>
- <p>
- <li>
- When property name is not empty but the property doesn't exist in
- the configuration, this method throws an {@link IllegalArgumentException}.
- </li>
- <p>
- @param out the writer to write to.]]>
- </doc>
- </method>
- <method name="dumpConfiguration"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="org.apache.hadoop.conf.Configuration"/>
- <param name="propertyName" type="java.lang.String"/>
- <param name="out" type="java.io.Writer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes properties and their attributes (final and resource)
- to the given {@link Writer}.
- <li>
- When propertyName is not empty, and the property exists
- in the configuration, the format of the output would be,
- <pre>
- {
- "property": {
- "key" : "key1",
- "value" : "value1",
- "isFinal" : "key1.isFinal",
- "resource" : "key1.resource"
- }
- }
- </pre>
- </li>
- <li>
- When propertyName is null or empty, it behaves same as
- {@link #dumpConfiguration(Configuration, Writer)}, the
- output would be,
- <pre>
- { "properties" :
- [ { key : "key1",
- value : "value1",
- isFinal : "key1.isFinal",
- resource : "key1.resource" },
- { key : "key2",
- value : "value2",
- isFinal : "ke2.isFinal",
- resource : "key2.resource" }
- ]
- }
- </pre>
- </li>
- <li>
- When propertyName is not empty, and the property is not
- found in the configuration, this method will throw an
- {@link IllegalArgumentException}.
- </li>
- <p>
- @param config the configuration
- @param propertyName property name
- @param out the Writer to write to
- @throws IOException
- @throws IllegalArgumentException when property name is not
- empty and the property is not found in configuration]]>
- </doc>
- </method>
- <method name="dumpConfiguration"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="org.apache.hadoop.conf.Configuration"/>
- <param name="out" type="java.io.Writer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes out all properties and their attributes (final and resource) to
- the given {@link Writer}, the format of the output would be,
- <pre>
- { "properties" :
- [ { key : "key1",
- value : "value1",
- isFinal : "key1.isFinal",
- resource : "key1.resource" },
- { key : "key2",
- value : "value2",
- isFinal : "ke2.isFinal",
- resource : "key2.resource" }
- ]
- }
- </pre>
- It does not output the properties of the configuration object which
- is loaded from an input stream.
- <p>
- @param config the configuration
- @param out the Writer to write to
- @throws IOException]]>
- </doc>
- </method>
- <method name="getClassLoader" return="java.lang.ClassLoader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ClassLoader} for this job.
- @return the correct class loader.]]>
- </doc>
- </method>
- <method name="setClassLoader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="classLoader" type="java.lang.ClassLoader"/>
- <doc>
- <![CDATA[Set the class loader that will be used to load the various objects.
-
- @param classLoader the new class loader.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setQuietMode"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="quietmode" type="boolean"/>
- <doc>
- <![CDATA[Set the quietness-mode.
-
- In the quiet-mode, error and informational messages might not be logged.
-
- @param quietmode <code>true</code> to set quiet-mode on, <code>false</code>
- to turn it off.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[For debugging. List non-default properties to the terminal and exit.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getValByRegex" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="regex" type="java.lang.String"/>
- <doc>
- <![CDATA[get keys matching the the regex
- @param regex
- @return Map<String,String> with matching keys]]>
- </doc>
- </method>
- <method name="dumpDeprecatedKeys"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hasWarnedDeprecation" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns whether or not a deprecated name has been warned. If the name is not
- deprecated then always return false]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Provides access to configuration parameters.
- <h4 id="Resources">Resources</h4>
- <p>Configurations are specified by resources. A resource contains a set of
- name/value pairs as XML data. Each resource is named by either a
- <code>String</code> or by a {@link Path}. If named by a <code>String</code>,
- then the classpath is examined for a file with that name. If named by a
- <code>Path</code>, then the local filesystem is examined directly, without
- referring to the classpath.
- <p>Unless explicitly turned off, Hadoop by default specifies two
- resources, loaded in-order from the classpath: <ol>
- <li><tt>
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a></tt>: Read-only defaults for hadoop.</li>
- <li><tt>core-site.xml</tt>: Site-specific configuration for a given hadoop
- installation.</li>
- </ol>
- Applications may add additional resources, which are loaded
- subsequent to these resources in the order they are added.
-
- <h4 id="FinalParams">Final Parameters</h4>
- <p>Configuration parameters may be declared <i>final</i>.
- Once a resource declares a value final, no subsequently-loaded
- resource can alter that value.
- For example, one might define a final parameter with:
- <tt><pre>
- <property>
- <name>dfs.hosts.include</name>
- <value>/etc/hadoop/conf/hosts.include</value>
- <b><final>true</final></b>
- </property></pre></tt>
- Administrators typically define parameters as final in
- <tt>core-site.xml</tt> for values that user applications may not alter.
- <h4 id="VariableExpansion">Variable Expansion</h4>
- <p>Value strings are first processed for <i>variable expansion</i>. The
- available properties are:<ol>
- <li>Other properties defined in this Configuration; and, if a name is
- undefined here,</li>
- <li>Properties in {@link System#getProperties()}.</li>
- </ol>
- <p>For example, if a configuration resource contains the following property
- definitions:
- <tt><pre>
- <property>
- <name>basedir</name>
- <value>/user/${<i>user.name</i>}</value>
- </property>
-
- <property>
- <name>tempdir</name>
- <value>${<i>basedir</i>}/tmp</value>
- </property></pre></tt>
- When <tt>conf.get("tempdir")</tt> is called, then <tt>${<i>basedir</i>}</tt>
- will be resolved to another property in this Configuration, while
- <tt>${<i>user.name</i>}</tt> would then ordinarily be resolved to the value
- of the System property with that name.
- <p>When <tt>conf.get("otherdir")</tt> is called, then <tt>${<i>env.BASE_DIR</i>}</tt>
- will be resolved to the value of the <tt>${<i>BASE_DIR</i>}</tt> environment variable.
- It supports <tt>${<i>env.NAME:-default</i>}</tt> and <tt>${<i>env.NAME-default</i>}</tt> notations.
- The former is resolved to "default" if <tt>${<i>NAME</i>}</tt> environment variable is undefined
- or its value is empty.
- The latter behaves the same way only if <tt>${<i>NAME</i>}</tt> is undefined.
- <p>By default, warnings will be given to any deprecated configuration
- parameters and these are suppressible by configuring
- <tt>log4j.logger.org.apache.hadoop.conf.Configuration.deprecation</tt> in
- log4j.properties file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.conf.Configuration -->
- <!-- start class org.apache.hadoop.conf.Configured -->
- <class name="Configured" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="Configured"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a Configured.]]>
- </doc>
- </constructor>
- <constructor name="Configured" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a Configured.]]>
- </doc>
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Base class for things that may be configured with a {@link Configuration}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.conf.Configured -->
- <!-- start class org.apache.hadoop.conf.ReconfigurationTaskStatus -->
- <class name="ReconfigurationTaskStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReconfigurationTaskStatus" type="long, long, java.util.Map"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="hasTask" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return true if
- - A reconfiguration task has finished or
- - an active reconfiguration task is running]]>
- </doc>
- </method>
- <method name="stopped" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return true if the latest reconfiguration task has finished and there is
- no another active task running.]]>
- </doc>
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getEndTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStatus" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.conf.ReconfigurationTaskStatus -->
- <doc>
- <![CDATA[Configuration of system parameters.]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.crypto">
- </package>
- <package name="org.apache.hadoop.crypto.key">
- <!-- start class org.apache.hadoop.crypto.key.KeyProvider -->
- <class name="KeyProvider" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KeyProvider" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
-
- @param conf configuration for the provider]]>
- </doc>
- </constructor>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the provider configuration.
-
- @return the provider configuration]]>
- </doc>
- </method>
- <method name="options" return="org.apache.hadoop.crypto.key.KeyProvider.Options"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[A helper function to create an options object.
- @param conf the configuration to use
- @return a new options object]]>
- </doc>
- </method>
- <method name="isTransient" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Indicates whether this provider represents a store
- that is intended for transient use - such as the UserProvider
- is. These providers are generally used to provide access to
- keying material rather than for long term storage.
- @return true if transient, false otherwise]]>
- </doc>
- </method>
- <method name="getKeyVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="versionName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the key material for a specific version of the key. This method is used
- when decrypting data.
- @param versionName the name of a specific version of the key
- @return the key material
- @throws IOException]]>
- </doc>
- </method>
- <method name="getKeys" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the key names for all keys.
- @return the list of key names
- @throws IOException]]>
- </doc>
- </method>
- <method name="getKeysMetadata" return="org.apache.hadoop.crypto.key.KeyProvider.Metadata[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get key metadata in bulk.
- @param names the names of the keys to get
- @throws IOException]]>
- </doc>
- </method>
- <method name="getKeyVersions" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the key material for all versions of a specific key name.
- @return the list of key material
- @throws IOException]]>
- </doc>
- </method>
- <method name="getCurrentKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the current version of the key, which should be used for encrypting new
- data.
- @param name the base name of the key
- @return the version name of the current version of the key or null if the
- key version doesn't exist
- @throws IOException]]>
- </doc>
- </method>
- <method name="getMetadata" return="org.apache.hadoop.crypto.key.KeyProvider.Metadata"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get metadata about the key.
- @param name the basename of the key
- @return the key's metadata or null if the key doesn't exist
- @throws IOException]]>
- </doc>
- </method>
- <method name="createKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="material" type="byte[]"/>
- <param name="options" type="org.apache.hadoop.crypto.key.KeyProvider.Options"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a new key. The given key must not already exist.
- @param name the base name of the key
- @param material the key material for the first version of the key.
- @param options the options for the new key.
- @return the version name of the first version of the key.
- @throws IOException]]>
- </doc>
- </method>
- <method name="generateKey" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="size" type="int"/>
- <param name="algorithm" type="java.lang.String"/>
- <exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
- <doc>
- <![CDATA[Generates a key material.
- @param size length of the key.
- @param algorithm algorithm to use for generating the key.
- @return the generated key.
- @throws NoSuchAlgorithmException]]>
- </doc>
- </method>
- <method name="createKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="options" type="org.apache.hadoop.crypto.key.KeyProvider.Options"/>
- <exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a new key generating the material for it.
- The given key must not already exist.
- <p/>
- This implementation generates the key material and calls the
- {@link #createKey(String, byte[], Options)} method.
- @param name the base name of the key
- @param options the options for the new key.
- @return the version name of the first version of the key.
- @throws IOException
- @throws NoSuchAlgorithmException]]>
- </doc>
- </method>
- <method name="deleteKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the given key.
- @param name the name of the key to delete
- @throws IOException]]>
- </doc>
- </method>
- <method name="rollNewVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="material" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Roll a new version of the given key.
- @param name the basename of the key
- @param material the new key material
- @return the name of the new version of the key
- @throws IOException]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Can be used by implementing classes to close any resources
- that require closing]]>
- </doc>
- </method>
- <method name="rollNewVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Roll a new version of the given key generating the material for it.
- <p/>
- This implementation generates the key material and calls the
- {@link #rollNewVersion(String, byte[])} method.
- @param name the basename of the key
- @return the name of the new version of the key
- @throws IOException]]>
- </doc>
- </method>
- <method name="flush"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Ensures that any changes to the keys are written to persistent store.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getBaseName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="versionName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Split the versionName in to a base name. Converts "/aaa/bbb/3" to
- "/aaa/bbb".
- @param versionName the version name to split
- @return the base name of the key
- @throws IOException]]>
- </doc>
- </method>
- <method name="buildVersionName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="version" type="int"/>
- <doc>
- <![CDATA[Build a version string from a basename and version number. Converts
- "/aaa/bbb" and 3 to "/aaa/bbb@3".
- @param name the basename of the key
- @param version the version of the key
- @return the versionName of the key.]]>
- </doc>
- </method>
- <method name="findProvider" return="org.apache.hadoop.crypto.key.KeyProvider"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="providerList" type="java.util.List"/>
- <param name="keyName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Find the provider with the given key.
- @param providerList the list of providers
- @param keyName the key name we are looking for
- @return the KeyProvider that has the key]]>
- </doc>
- </method>
- <method name="needsPassword" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Does this provider require a password? This means that a password is
- required for normal operation, and it has not been found through normal
- means. If true, the password should be provided by the caller using
- setPassword().
- @return Whether or not the provider requires a password
- @throws IOException]]>
- </doc>
- </method>
- <method name="noPasswordWarning" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If a password for the provider is needed, but is not provided, this will
- return a warning and instructions for supplying said password to the
- provider.
- @return A warning and instructions for supplying the password]]>
- </doc>
- </method>
- <method name="noPasswordError" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If a password for the provider is needed, but is not provided, this will
- return an error message and instructions for supplying said password to
- the provider.
- @return An error message and instructions for supplying the password]]>
- </doc>
- </method>
- <field name="DEFAULT_CIPHER_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CIPHER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_BITLENGTH_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_BITLENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JCEKS_KEY_SERIALFILTER_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JCEKS_KEY_SERIAL_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A provider of secret key material for Hadoop applications. Provides an
- abstraction to separate key storage from users of encryption. It
- is intended to support getting or storing keys in a variety of ways,
- including third party bindings.
- <P/>
- <code>KeyProvider</code> implementations must be thread safe.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.crypto.key.KeyProvider -->
- <!-- start class org.apache.hadoop.crypto.key.KeyProviderFactory -->
- <class name="KeyProviderFactory" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KeyProviderFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createProvider" return="org.apache.hadoop.crypto.key.KeyProvider"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="providerName" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getProviders" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="get" return="org.apache.hadoop.crypto.key.KeyProvider"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a KeyProvider based on a provided URI.
- @param uri key provider URI
- @param conf configuration to initialize the key provider
- @return the key provider for the specified URI, or <code>NULL</code> if
- a provider for the specified URI scheme could not be found.
- @throws IOException thrown if the provider failed to initialize.]]>
- </doc>
- </method>
- <field name="KEY_PROVIDER_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A factory to create a list of KeyProvider based on the path given in a
- Configuration. It uses a service loader interface to find the available
- KeyProviders and create them based on the list of URIs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.crypto.key.KeyProviderFactory -->
- </package>
- <package name="org.apache.hadoop.crypto.key.kms">
- </package>
- <package name="org.apache.hadoop.crypto.random">
- </package>
- <package name="org.apache.hadoop.fs">
- <!-- start class org.apache.hadoop.fs.AbstractFileSystem -->
- <class name="AbstractFileSystem" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AbstractFileSystem" type="java.net.URI, java.lang.String, boolean, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
- <doc>
- <![CDATA[Constructor to be called by subclasses.
-
- @param uri for this file system.
- @param supportedScheme the scheme supported by the implementor
- @param authorityNeeded if true then theURI must have authority, if false
- then the URI must have null authority.
- @throws URISyntaxException <code>uri</code> has syntax error]]>
- </doc>
- </constructor>
- <method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isValidName" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns true if the specified string is considered valid in the path part
- of a URI by this file system. The default implementation enforces the rules
- of HDFS, but subclasses may override this method to implement specific
- validation rules for specific file systems.
-
- @param src String source filename to check, path part of the URI
- @return boolean true if the specified string is considered valid]]>
- </doc>
- </method>
- <method name="createFileSystem" return="org.apache.hadoop.fs.AbstractFileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <doc>
- <![CDATA[Create a file system instance for the specified uri using the conf. The
- conf is used to find the class name that implements the file system. The
- conf is also passed to the file system for its configuration.
- @param uri URI of the file system
- @param conf Configuration for the file system
-
- @return Returns the file system for the given URI
- @throws UnsupportedFileSystemException file system for <code>uri</code> is
- not found]]>
- </doc>
- </method>
- <method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <doc>
- <![CDATA[Get the statistics for a particular file system.
-
- @param uri
- used as key to lookup STATISTICS_TABLE. Only scheme and authority
- part of the uri are used.
- @return a statistics object]]>
- </doc>
- </method>
- <method name="clearStatistics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="printStatistics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prints statistics for all file systems.]]>
- </doc>
- </method>
- <method name="getAllStatistics" return="java.util.Map"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="get" return="org.apache.hadoop.fs.AbstractFileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <doc>
- <![CDATA[The main factory method for creating a file system. Get a file system for
- the URI's scheme and authority. The scheme of the <code>uri</code>
- determines a configuration property name,
- <tt>fs.AbstractFileSystem.<i>scheme</i>.impl</tt> whose value names the
- AbstractFileSystem class.
-
- The entire URI and conf is passed to the AbstractFileSystem factory method.
-
- @param uri for the file system to be created.
- @param conf which is passed to the file system impl.
-
- @return file system for the given URI.
-
- @throws UnsupportedFileSystemException if the file system for
- <code>uri</code> is not supported.]]>
- </doc>
- </method>
- <method name="checkScheme"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="supportedScheme" type="java.lang.String"/>
- <doc>
- <![CDATA[Check that the Uri's scheme matches
- @param uri
- @param supportedScheme]]>
- </doc>
- </method>
- <method name="getUriDefaultPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default port of this file system.
-
- @return default port of this file system's Uri scheme
- A uri with a port of -1 => default port;]]>
- </doc>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a URI whose scheme and authority identify this FileSystem.
-
- @return the uri of this file system.]]>
- </doc>
- </method>
- <method name="checkPath"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Check that a Path belongs to this FileSystem.
-
- If the path is fully qualified URI, then its scheme and authority
- matches that of this file system. Otherwise the path must be
- slash-relative name.
-
- @throws InvalidPathException if the path is invalid]]>
- </doc>
- </method>
- <method name="getUriPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Get the path-part of a pathname. Checks that URI matches this file system
- and that the path-part is a valid name.
-
- @param p path
-
- @return path-part of the Path p]]>
- </doc>
- </method>
- <method name="makeQualified" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Make the path fully qualified to this file system
- @param path
- @return the qualified path]]>
- </doc>
- </method>
- <method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Some file systems like LocalFileSystem have an initial workingDir
- that is used as the starting workingDir. For other file systems
- like HDFS there is no built in notion of an initial workingDir.
-
- @return the initial workingDir if the file system has such a notion
- otherwise return a null.]]>
- </doc>
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the current user's home directory in this file system.
- The default implementation returns "/user/$USER/".
-
- @return current user's home directory.]]>
- </doc>
- </method>
- <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getServerDefaults(Path)} instead">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a set of server default configuration values.
-
- @return server default configuration values
-
- @throws IOException an I/O error occurred
- @deprecated use {@link #getServerDefaults(Path)} instead]]>
- </doc>
- </method>
- <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a set of server default configuration values based on path.
- @param f path to fetch server defaults
- @return server default configuration values for path
- @throws IOException an I/O error occurred]]>
- </doc>
- </method>
- <method name="resolvePath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the fully-qualified path of path f resolving the path
- through any internal symlinks or mount point
- @param p path to be resolved
- @return fully qualified path
- @throws FileNotFoundException, AccessControlException, IOException
- UnresolvedLinkException if symbolic link on path cannot be resolved
- internally]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="createFlag" type="java.util.EnumSet"/>
- <param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#create(Path, EnumSet, Options.CreateOpts...)} except
- that the Path f must be fully qualified and the permission is absolute
- (i.e. umask has been applied).]]>
- </doc>
- </method>
- <method name="createInternal" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="flag" type="java.util.EnumSet"/>
- <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
- <param name="createParent" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link #create(Path, EnumSet, Options.CreateOpts...)} except that the opts
- have been declared explicitly.]]>
- </doc>
- </method>
- <method name="mkdir"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="createParent" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#mkdir(Path, FsPermission, boolean)} except that the Path
- f must be fully qualified and the permission is absolute (i.e.
- umask has been applied).]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#delete(Path, boolean)} except that Path f must be for
- this file system.]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#open(Path)} except that Path f must be for this
- file system.]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#open(Path, int)} except that Path f must be for this
- file system.]]>
- </doc>
- </method>
- <method name="truncate" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="newLength" type="long"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#truncate(Path, long)} except that Path f must be for
- this file system.]]>
- </doc>
- </method>
- <method name="setReplication" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#setReplication(Path, short)} except that Path f must be
- for this file system.]]>
- </doc>
- </method>
- <method name="rename"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="options" type="org.apache.hadoop.fs.Options.Rename[]"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
- f must be for this file system.]]>
- </doc>
- </method>
- <method name="renameInternal"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
- f must be for this file system and NO OVERWRITE is performed.
-
- File systems that do not have a built in overwrite need implement only this
- method and can take advantage of the default impl of the other
- {@link #renameInternal(Path, Path, boolean)}]]>
- </doc>
- </method>
- <method name="renameInternal"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
- f must be for this file system.]]>
- </doc>
- </method>
- <method name="supportsSymlinks" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the file system supports symlinks, false otherwise.
- @return true if filesystem supports symlinks]]>
- </doc>
- </method>
- <method name="createSymlink"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="org.apache.hadoop.fs.Path"/>
- <param name="link" type="org.apache.hadoop.fs.Path"/>
- <param name="createParent" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#createSymlink(Path, Path, boolean)};]]>
- </doc>
- </method>
- <method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Partially resolves the path. This is used during symlink resolution in
- {@link FSLinkResolver}, and differs from the similarly named method
- {@link FileContext#getLinkTarget(Path)}.
- @throws IOException subclass implementations may throw IOException]]>
- </doc>
- </method>
- <method name="setPermission"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#setPermission(Path, FsPermission)} except that Path f
- must be for this file system.]]>
- </doc>
- </method>
- <method name="setOwner"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#setOwner(Path, String, String)} except that Path f must
- be for this file system.]]>
- </doc>
- </method>
- <method name="setTimes"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="mtime" type="long"/>
- <param name="atime" type="long"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#setTimes(Path, long, long)} except that Path f must be
- for this file system.]]>
- </doc>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#getFileChecksum(Path)} except that Path f must be for
- this file system.]]>
- </doc>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#getFileStatus(Path)}
- except that an UnresolvedLinkException may be thrown if a symlink is
- encountered in the path.]]>
- </doc>
- </method>
- <method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#getFileLinkStatus(Path)}
- except that an UnresolvedLinkException may be thrown if a symlink is
- encountered in the path leading up to the final path component.
- If the file system does not support symlinks then the behavior is
- equivalent to {@link AbstractFileSystem#getFileStatus(Path)}.]]>
- </doc>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="start" type="long"/>
- <param name="len" type="long"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#getFileBlockLocations(Path, long, long)} except that
- Path f must be for this file system.]]>
- </doc>
- </method>
- <method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#getFsStatus(Path)} except that Path f must be for this
- file system.]]>
- </doc>
- </method>
- <method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#getFsStatus(Path)}.]]>
- </doc>
- </method>
- <method name="listStatusIterator" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#listStatus(Path)} except that Path f must be for this
- file system.]]>
- </doc>
- </method>
- <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#listLocatedStatus(Path)} except that Path f
- must be for this file system.]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext.Util#listStatus(Path)} except that Path f must be
- for this file system.]]>
- </doc>
- </method>
- <method name="listCorruptFileBlocks" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return an iterator over the corrupt files under the given path
- (may contain duplicates if a file has more than one corrupt block)
- @throws IOException]]>
- </doc>
- </method>
- <method name="setVerifyChecksum"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#setVerifyChecksum(boolean, Path)} except that Path f
- must be for this file system.]]>
- </doc>
- </method>
- <method name="getCanonicalServiceName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a canonical name for this file system.
- @return a URI string that uniquely identifies this file system]]>
- </doc>
- </method>
- <method name="modifyAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Modifies ACL entries of files and directories. This method can add new ACL
- entries or modify the permissions on existing ACL entries. All existing
- ACL entries that are not specified in this call are retained without
- changes. (Modifications are merged into the current ACL.)
- @param path Path to modify
- @param aclSpec List<AclEntry> describing modifications
- @throws IOException if an ACL could not be modified]]>
- </doc>
- </method>
- <method name="removeAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Removes ACL entries from files and directories. Other ACL entries are
- retained.
- @param path Path to modify
- @param aclSpec List<AclEntry> describing entries to remove
- @throws IOException if an ACL could not be modified]]>
- </doc>
- </method>
- <method name="removeDefaultAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Removes all default ACL entries from files and directories.
- @param path Path to modify
- @throws IOException if an ACL could not be modified]]>
- </doc>
- </method>
- <method name="removeAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Removes all but the base ACL entries of files and directories. The entries
- for user, group, and others are retained for compatibility with permission
- bits.
- @param path Path to modify
- @throws IOException if an ACL could not be removed]]>
- </doc>
- </method>
- <method name="setAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fully replaces ACL of files and directories, discarding all existing
- entries.
- @param path Path to modify
- @param aclSpec List<AclEntry> describing modifications, must include entries
- for user, group, and others for compatibility with permission bits.
- @throws IOException if an ACL could not be modified]]>
- </doc>
- </method>
- <method name="getAclStatus" return="org.apache.hadoop.fs.permission.AclStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the ACLs of files and directories.
- @param path Path to get
- @return RemoteIterator<AclStatus> which returns each AclStatus
- @throws IOException if an ACL could not be read]]>
- </doc>
- </method>
- <method name="setXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set an xattr of a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to modify
- @param name xattr name.
- @param value xattr value.
- @throws IOException]]>
- </doc>
- </method>
- <method name="setXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="byte[]"/>
- <param name="flag" type="java.util.EnumSet"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set an xattr of a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to modify
- @param name xattr name.
- @param value xattr value.
- @param flag xattr set flag
- @throws IOException]]>
- </doc>
- </method>
- <method name="getXAttr" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get an xattr for a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attribute
- @param name xattr name.
- @return byte[] xattr value.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all of the xattrs for a file or directory.
- Only those xattrs for which the logged-in user has permissions to view
- are returned.
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attributes
- @return Map<String, byte[]> describing the XAttrs of the file or directory
- @throws IOException]]>
- </doc>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="names" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all of the xattrs for a file or directory.
- Only those xattrs for which the logged-in user has permissions to view
- are returned.
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attributes
- @param names XAttr names.
- @return Map<String, byte[]> describing the XAttrs of the file or directory
- @throws IOException]]>
- </doc>
- </method>
- <method name="listXAttrs" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all of the xattr names for a file or directory.
- Only the xattr names for which the logged-in user has permissions to view
- are returned.
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attributes
- @return Map<String, byte[]> describing the XAttrs of the file or directory
- @throws IOException]]>
- </doc>
- </method>
- <method name="removeXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Remove an xattr of a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to remove extended attribute
- @param name xattr name
- @throws IOException]]>
- </doc>
- </method>
- <method name="createSnapshot" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#createSnapshot(Path, String)}.]]>
- </doc>
- </method>
- <method name="renameSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotOldName" type="java.lang.String"/>
- <param name="snapshotNewName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#renameSnapshot(Path, String, String)}.]]>
- </doc>
- </method>
- <method name="deleteSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="snapshotDir" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The specification of this method matches that of
- {@link FileContext#deleteSnapshot(Path, String)}.]]>
- </doc>
- </method>
- <method name="setStoragePolicy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="policyName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the storage policy for a given file or directory.
- @param path file or directory path.
- @param policyName the name of the target storage policy. The list
- of supported Storage policies can be retrieved
- via {@link #getAllStoragePolicies}.]]>
- </doc>
- </method>
- <method name="unsetStoragePolicy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Unset the storage policy set for a given file or directory.
- @param src file or directory path.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getStoragePolicy" return="org.apache.hadoop.fs.BlockStoragePolicySpi"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Retrieve the storage policy for a given file or directory.
- @param src file or directory path.
- @return storage policy for give file.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getAllStoragePolicies" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Retrieve all the storage policies supported by this file system.
- @return all storage policies supported by this filesystem.
- @throws IOException]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <field name="statistics" type="org.apache.hadoop.fs.FileSystem.Statistics"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The statistics for this file system.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This class provides an interface for implementors of a Hadoop file system
- (analogous to the VFS of Unix). Applications do not access this class;
- instead they access files across all file systems using {@link FileContext}.
-
- Pathnames passed to AbstractFileSystem can be fully qualified URI that
- matches the "this" file system (ie same scheme and authority)
- or a Slash-relative name that is assumed to be relative
- to the root of the "this" file system .]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.AbstractFileSystem -->
- <!-- start class org.apache.hadoop.fs.AvroFSInput -->
- <class name="AvroFSInput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <implements name="org.apache.avro.file.SeekableInput"/>
- <constructor name="AvroFSInput" type="org.apache.hadoop.fs.FSDataInputStream, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct given an {@link FSDataInputStream} and its length.]]>
- </doc>
- </constructor>
- <constructor name="AvroFSInput" type="org.apache.hadoop.fs.FileContext, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct given a {@link FileContext} and a {@link Path}.]]>
- </doc>
- </constructor>
- <method name="length" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="seek"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="tell" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Adapts an {@link FSDataInputStream} to Avro's SeekableInput interface.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.AvroFSInput -->
- <!-- start class org.apache.hadoop.fs.BlockLocation -->
- <class name="BlockLocation" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BlockLocation"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default Constructor]]>
- </doc>
- </constructor>
- <constructor name="BlockLocation" type="org.apache.hadoop.fs.BlockLocation"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Copy constructor]]>
- </doc>
- </constructor>
- <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor with host, name, offset and length]]>
- </doc>
- </constructor>
- <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], long, long, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor with host, name, offset, length and corrupt flag]]>
- </doc>
- </constructor>
- <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor with host, name, network topology, offset and length]]>
- </doc>
- </constructor>
- <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], long, long, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor with host, name, network topology, offset, length
- and corrupt flag]]>
- </doc>
- </constructor>
- <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], java.lang.String[], long, long, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], java.lang.String[], java.lang.String[], org.apache.hadoop.fs.StorageType[], long, long, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getHosts" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the list of hosts (hostname) hosting this block]]>
- </doc>
- </method>
- <method name="getCachedHosts" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of hosts (hostname) hosting a cached replica of the block]]>
- </doc>
- </method>
- <method name="getNames" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the list of names (IP:xferPort) hosting this block]]>
- </doc>
- </method>
- <method name="getTopologyPaths" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the list of network topology paths for each of the hosts.
- The last component of the path is the "name" (IP:xferPort).]]>
- </doc>
- </method>
- <method name="getStorageIds" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the storageID of each replica of the block.]]>
- </doc>
- </method>
- <method name="getStorageTypes" return="org.apache.hadoop.fs.StorageType[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the storage type of each replica of the block.]]>
- </doc>
- </method>
- <method name="getOffset" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the start offset of file associated with this block]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the length of the block]]>
- </doc>
- </method>
- <method name="isCorrupt" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the corrupt flag.]]>
- </doc>
- </method>
- <method name="setOffset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="offset" type="long"/>
- <doc>
- <![CDATA[Set the start offset of file associated with this block]]>
- </doc>
- </method>
- <method name="setLength"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="length" type="long"/>
- <doc>
- <![CDATA[Set the length of block]]>
- </doc>
- </method>
- <method name="setCorrupt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="corrupt" type="boolean"/>
- <doc>
- <![CDATA[Set the corrupt flag.]]>
- </doc>
- </method>
- <method name="setHosts"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hosts" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the hosts hosting this block]]>
- </doc>
- </method>
- <method name="setCachedHosts"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cachedHosts" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Set the hosts hosting a cached replica of this block]]>
- </doc>
- </method>
- <method name="setNames"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the names (host:port) hosting this block]]>
- </doc>
- </method>
- <method name="setTopologyPaths"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="topologyPaths" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the network topology paths of the hosts]]>
- </doc>
- </method>
- <method name="setStorageIds"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="storageIds" type="java.lang.String[]"/>
- </method>
- <method name="setStorageTypes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="storageTypes" type="org.apache.hadoop.fs.StorageType[]"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Represents the network location of a block, information about the hosts
- that contain block replicas, and other block metadata (E.g. the file
- offset associated with the block, length, whether it is corrupt, etc).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.BlockLocation -->
- <!-- start interface org.apache.hadoop.fs.BlockStoragePolicySpi -->
- <interface name="BlockStoragePolicySpi" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the name of the storage policy. Policies are uniquely
- identified by name.
- @return the name of the storage policy.]]>
- </doc>
- </method>
- <method name="getStorageTypes" return="org.apache.hadoop.fs.StorageType[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the preferred storage types associated with this policy. These
- storage types are used sequentially for successive block replicas.
- @return preferred storage types used for placing block replicas.]]>
- </doc>
- </method>
- <method name="getCreationFallbacks" return="org.apache.hadoop.fs.StorageType[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the fallback storage types for creating new block replicas. Fallback
- storage types are used if the preferred storage types are not available.
- @return fallback storage types for new block replicas..]]>
- </doc>
- </method>
- <method name="getReplicationFallbacks" return="org.apache.hadoop.fs.StorageType[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the fallback storage types for replicating existing block replicas.
- Fallback storage types are used if the preferred storage types are not
- available.
- @return fallback storage types for replicating existing block replicas.]]>
- </doc>
- </method>
- <method name="isCopyOnCreateFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the policy is inherit-only and cannot be changed for
- an existing file.
- @return true if the policy is inherit-only.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A storage policy specifies the placement of block replicas on specific
- storage types.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.BlockStoragePolicySpi -->
- <!-- start interface org.apache.hadoop.fs.ByteBufferPositionedReadable -->
- <interface name="ByteBufferPositionedReadable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buf" type="java.nio.ByteBuffer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads up to {@code buf.remaining()} bytes into buf from a given position in
- the file and returns the number of bytes read. Callers should use
- {@code buf.limit(...)} to control the size of the desired read and
- {@code buf.position(...)} to control the offset into the buffer the data
- should be written to.
- <p>
- After a successful call, {@code buf.position()} will be advanced by the
- number of bytes read and {@code buf.limit()} will be unchanged.
- <p>
- In the case of an exception, the state of the buffer (the contents of the
- buffer, the {@code buf.position()}, the {@code buf.limit()}, etc.) is
- undefined, and callers should be prepared to recover from this eventuality.
- <p>
- Callers should use {@link StreamCapabilities#hasCapability(String)} with
- {@link StreamCapabilities#PREADBYTEBUFFER} to check if the underlying
- stream supports this interface, otherwise they might get a
- {@link UnsupportedOperationException}.
- <p>
- Implementations should treat 0-length requests as legitimate, and must not
- signal an error upon their receipt.
- @param position position within file
- @param buf the ByteBuffer to receive the results of the read operation.
- @return the number of bytes read, possibly zero, or -1 if reached
- end-of-stream
- @throws IOException if there is some error performing the read]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implementers of this interface provide a positioned read API that writes to a
- {@link ByteBuffer} rather than a {@code byte[]}.
- @see PositionedReadable
- @see ByteBufferReadable]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.ByteBufferPositionedReadable -->
- <!-- start interface org.apache.hadoop.fs.ByteBufferReadable -->
- <interface name="ByteBufferReadable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="java.nio.ByteBuffer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads up to buf.remaining() bytes into buf. Callers should use
- buf.limit(..) to control the size of the desired read.
- <p/>
- After a successful call, buf.position() will be advanced by the number
- of bytes read and buf.limit() should be unchanged.
- <p/>
- In the case of an exception, the values of buf.position() and buf.limit()
- are undefined, and callers should be prepared to recover from this
- eventuality.
- <p/>
- Many implementations will throw {@link UnsupportedOperationException}, so
- callers that are not confident in support for this method from the
- underlying filesystem should be prepared to handle that exception.
- <p/>
- Implementations should treat 0-length requests as legitimate, and must not
- signal an error upon their receipt.
- @param buf
- the ByteBuffer to receive the results of the read operation.
- @return the number of bytes read, possibly zero, or -1 if
- reach end-of-stream
- @throws IOException
- if there is some error performing the read]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implementers of this interface provide a read API that writes to a
- ByteBuffer, not a byte[].]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.ByteBufferReadable -->
- <!-- start interface org.apache.hadoop.fs.CanSetDropBehind -->
- <interface name="CanSetDropBehind" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setDropBehind"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dropCache" type="java.lang.Boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- <doc>
- <![CDATA[Configure whether the stream should drop the cache.
- @param dropCache Whether to drop the cache. null means to use the
- default value.
- @throws IOException If there was an error changing the dropBehind
- setting.
- UnsupportedOperationException If this stream doesn't support
- setting the drop-behind.]]>
- </doc>
- </method>
- </interface>
- <!-- end interface org.apache.hadoop.fs.CanSetDropBehind -->
- <!-- start interface org.apache.hadoop.fs.CanSetReadahead -->
- <interface name="CanSetReadahead" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setReadahead"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="readahead" type="java.lang.Long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- <doc>
- <![CDATA[Set the readahead on this stream.
- @param readahead The readahead to use. null means to use the default.
- @throws IOException If there was an error changing the dropBehind
- setting.
- UnsupportedOperationException If this stream doesn't support
- setting readahead.]]>
- </doc>
- </method>
- </interface>
- <!-- end interface org.apache.hadoop.fs.CanSetReadahead -->
- <!-- start interface org.apache.hadoop.fs.CanUnbuffer -->
- <interface name="CanUnbuffer" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="unbuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reduce the buffering. This will also free sockets and file descriptors
- held by the stream, if possible.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[FSDataInputStreams implement this interface to indicate that they can clear
- their buffers on request.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.CanUnbuffer -->
- <!-- start class org.apache.hadoop.fs.ChecksumException -->
- <class name="ChecksumException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ChecksumException" type="java.lang.String, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Thrown for checksum errors.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ChecksumException -->
- <!-- start class org.apache.hadoop.fs.ChecksumFileSystem -->
- <class name="ChecksumFileSystem" extends="org.apache.hadoop.fs.FilterFileSystem"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ChecksumFileSystem" type="org.apache.hadoop.fs.FileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApproxChkSumLength" return="double"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="size" type="long"/>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="setVerifyChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- <doc>
- <![CDATA[Set whether to verify checksum.]]>
- </doc>
- </method>
- <method name="setWriteChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writeChecksum" type="boolean"/>
- </method>
- <method name="getRawFileSystem" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the raw file system]]>
- </doc>
- </method>
- <method name="getChecksumFile" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Return the name of the checksum file associated with a file.]]>
- </doc>
- </method>
- <method name="isChecksumFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Return true iff file is a checksum file name.]]>
- </doc>
- </method>
- <method name="getChecksumFileLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="fileSize" type="long"/>
- <doc>
- <![CDATA[Return the length of the checksum file given the size of the
- actual file.]]>
- </doc>
- </method>
- <method name="getBytesPerSum" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the bytes Per Checksum]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataInputStream at the indicated Path.
- @param f the file name to open
- @param bufferSize the size of the buffer to be used.]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="truncate" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="newLength" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getChecksumLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="size" type="long"/>
- <param name="bytesPerSum" type="int"/>
- <doc>
- <![CDATA[Calculated the length of the checksum file in bytes.
- @param size the length of the data file in bytes
- @param bytesPerSum the number of bytes in a checksum block
- @return the number of bytes in the checksum file]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="modifyAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeDefaultAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set replication for an existing file.
- Implement the abstract <tt>setReplication</tt> of <tt>FileSystem</tt>
- @param src file name
- @param replication new replication
- @throws IOException
- @return true if successful;
- false if file does not exist or is a directory]]>
- </doc>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Rename files/dirs]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Implement the delete(Path, boolean) in checksum
- file system.]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List the statuses of the files/directories in the given path if the path is
- a directory.
-
- @param f
- given path
- @return the statuses of the files/directories in the given path
- @throws IOException]]>
- </doc>
- </method>
- <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List the statuses of the files/directories in the given path if the path is
- a directory.
-
- @param f
- given path
- @return the statuses of the files/directories in the given patch
- @throws IOException]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is under FS, and the dst is on the local disk.
- Copy it from FS control to the local dst name.]]>
- </doc>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="copyCrc" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is under FS, and the dst is on the local disk.
- Copy it from FS control to the local dst name.
- If src and dst are directories, the copyCrc parameter
- determines whether to copy CRC files.]]>
- </doc>
- </method>
- <method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="completeLocalOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="reportChecksumFailure" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="in" type="org.apache.hadoop.fs.FSDataInputStream"/>
- <param name="inPos" type="long"/>
- <param name="sums" type="org.apache.hadoop.fs.FSDataInputStream"/>
- <param name="sumsPos" type="long"/>
- <doc>
- <![CDATA[Report a checksum error to the file system.
- @param f the file name containing the error
- @param in the stream open on the file
- @param inPos the position of the beginning of the bad data in the file
- @param sums the stream open on the checksum file
- @param sumsPos the position of the beginning of the bad data in the checksum file
- @return if retry is neccessary]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Abstract Checksumed FileSystem.
- It provide a basic implementation of a Checksumed FileSystem,
- which creates a checksum file for each raw file.
- It generates & verifies checksums at the client side.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ChecksumFileSystem -->
- <!-- start class org.apache.hadoop.fs.CommonConfigurationKeysPublic -->
- <class name="CommonConfigurationKeysPublic" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CommonConfigurationKeysPublic"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="IO_NATIVE_LIB_AVAILABLE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IO_NATIVE_LIB_AVAILABLE_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IO_NATIVE_LIB_AVAILABLE_KEY]]>
- </doc>
- </field>
- <field name="NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_KEY]]>
- </doc>
- </field>
- <field name="FS_DEFAULT_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_DEFAULT_NAME_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for FS_DEFAULT_NAME_KEY]]>
- </doc>
- </field>
- <field name="FS_DF_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_DF_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for FS_DF_INTERVAL_KEY]]>
- </doc>
- </field>
- <field name="FS_DU_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_DU_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for FS_DU_INTERVAL_KEY]]>
- </doc>
- </field>
- <field name="FS_GETSPACEUSED_CLASSNAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_GETSPACEUSED_JITTER_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_GETSPACEUSED_JITTER_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for FS_GETSPACEUSED_JITTER_KEY]]>
- </doc>
- </field>
- <field name="FS_CLIENT_RESOLVE_REMOTE_SYMLINKS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_CLIENT_RESOLVE_REMOTE_SYMLINKS_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for FS_CLIENT_RESOLVE_REMOTE_SYMLINKS_KEY]]>
- </doc>
- </field>
- <field name="NET_TOPOLOGY_SCRIPT_FILE_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="NET_TOPOLOGY_NODE_SWITCH_MAPPING_IMPL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="NET_TOPOLOGY_IMPL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="NET_TOPOLOGY_TABLE_MAPPING_FILE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="NET_DEPENDENCY_SCRIPT_FILE_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_TRASH_CHECKPOINT_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_TRASH_CHECKPOINT_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for FS_TRASH_CHECKPOINT_INTERVAL_KEY]]>
- </doc>
- </field>
- <field name="FS_PROTECTED_DIRECTORIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Directories that cannot be removed unless empty, even by an
- administrator.]]>
- </doc>
- </field>
- <field name="FS_LOCAL_BLOCK_SIZE_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Not used anywhere, looks like default value for FS_LOCAL_BLOCK_SIZE]]>
- </doc>
- </field>
- <field name="FS_AUTOMATIC_CLOSE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_AUTOMATIC_CLOSE_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for FS_AUTOMATIC_CLOSE_KEY]]>
- </doc>
- </field>
- <field name="FS_FILE_IMPL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_FTP_HOST_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_FTP_HOST_PORT_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_TRASH_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_TRASH_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for FS_TRASH_INTERVAL_KEY]]>
- </doc>
- </field>
- <field name="FS_CLIENT_TOPOLOGY_RESOLUTION_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="FS_CLIENT_TOPOLOGY_RESOLUTION_ENABLED_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for FS_CLIENT_TOPOLOGY_RESOLUTION_ENABLED.]]>
- </doc>
- </field>
- <field name="IO_MAPFILE_BLOOM_SIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IO_MAPFILE_BLOOM_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IO_MAPFILE_BLOOM_SIZE_KEY]]>
- </doc>
- </field>
- <field name="IO_MAPFILE_BLOOM_ERROR_RATE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IO_MAPFILE_BLOOM_ERROR_RATE_DEFAULT" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IO_MAPFILE_BLOOM_ERROR_RATE_KEY]]>
- </doc>
- </field>
- <field name="IO_COMPRESSION_CODEC_LZO_CLASS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Codec class that implements Lzo compression algorithm]]>
- </doc>
- </field>
- <field name="IO_MAP_INDEX_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IO_MAP_INDEX_INTERVAL_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IO_MAP_INDEX_INTERVAL_DEFAULT]]>
- </doc>
- </field>
- <field name="IO_MAP_INDEX_SKIP_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IO_MAP_INDEX_SKIP_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IO_MAP_INDEX_SKIP_KEY]]>
- </doc>
- </field>
- <field name="IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IO_SEQFILE_COMPRESS_BLOCKSIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY]]>
- </doc>
- </field>
- <field name="IO_FILE_BUFFER_SIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IO_FILE_BUFFER_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IO_FILE_BUFFER_SIZE_KEY]]>
- </doc>
- </field>
- <field name="IO_SKIP_CHECKSUM_ERRORS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IO_SKIP_CHECKSUM_ERRORS_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IO_SKIP_CHECKSUM_ERRORS_KEY]]>
- </doc>
- </field>
- <field name="IO_SORT_MB_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="Moved to mapreduce, see mapreduce.task.io.sort.mb
- in mapred-default.xml
- See https://issues.apache.org/jira/browse/HADOOP-6801
- For {@link org.apache.hadoop.io.SequenceFile.Sorter} control
- instead, see {@link #SEQ_IO_SORT_MB_KEY}.">
- <doc>
- <![CDATA[@deprecated Moved to mapreduce, see mapreduce.task.io.sort.mb
- in mapred-default.xml
- See https://issues.apache.org/jira/browse/HADOOP-6801
- For {@link org.apache.hadoop.io.SequenceFile.Sorter} control
- instead, see {@link #SEQ_IO_SORT_MB_KEY}.]]>
- </doc>
- </field>
- <field name="IO_SORT_MB_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for {@link #IO_SORT_MB_KEY}.]]>
- </doc>
- </field>
- <field name="IO_SORT_FACTOR_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="Moved to mapreduce, see mapreduce.task.io.sort.factor
- in mapred-default.xml
- See https://issues.apache.org/jira/browse/HADOOP-6801
- For {@link org.apache.hadoop.io.SequenceFile.Sorter} control
- instead, see {@link #SEQ_IO_SORT_FACTOR_KEY}.">
- <doc>
- <![CDATA[@deprecated Moved to mapreduce, see mapreduce.task.io.sort.factor
- in mapred-default.xml
- See https://issues.apache.org/jira/browse/HADOOP-6801
- For {@link org.apache.hadoop.io.SequenceFile.Sorter} control
- instead, see {@link #SEQ_IO_SORT_FACTOR_KEY}.]]>
- </doc>
- </field>
- <field name="IO_SORT_FACTOR_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for {@link #IO_SORT_FACTOR_KEY}.]]>
- </doc>
- </field>
- <field name="SEQ_IO_SORT_MB_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="SEQ_IO_SORT_MB_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for {@link #SEQ_IO_SORT_MB_KEY}.]]>
- </doc>
- </field>
- <field name="SEQ_IO_SORT_FACTOR_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="SEQ_IO_SORT_FACTOR_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for {@link #SEQ_IO_SORT_FACTOR_KEY}.]]>
- </doc>
- </field>
- <field name="IO_SERIALIZATIONS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="TFILE_IO_CHUNK_SIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="TFILE_IO_CHUNK_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for TFILE_IO_CHUNK_SIZE_DEFAULT]]>
- </doc>
- </field>
- <field name="TFILE_FS_INPUT_BUFFER_SIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="TFILE_FS_INPUT_BUFFER_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for TFILE_FS_INPUT_BUFFER_SIZE_KEY]]>
- </doc>
- </field>
- <field name="TFILE_FS_OUTPUT_BUFFER_SIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="TFILE_FS_OUTPUT_BUFFER_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for TFILE_FS_OUTPUT_BUFFER_SIZE_KEY]]>
- </doc>
- </field>
- <field name="HADOOP_CALLER_CONTEXT_ENABLED_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_CALLER_CONTEXT_ENABLED_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_CALLER_CONTEXT_MAX_SIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_CALLER_CONTEXT_MAX_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_CALLER_CONTEXT_SIGNATURE_MAX_SIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_CALLER_CONTEXT_SIGNATURE_MAX_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_CONNECTION_MAXIDLETIME_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_CONNECT_TIMEOUT_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_CONNECT_TIMEOUT_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_CLIENT_CONNECT_TIMEOUT_KEY]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_CONNECT_MAX_RETRIES_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_CONNECT_MAX_RETRIES_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_CLIENT_CONNECT_MAX_RETRIES_KEY]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_CONNECT_RETRY_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_CONNECT_RETRY_INTERVAL_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_CLIENT_CONNECT_RETRY_INTERVAL_KEY]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_KEY]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_TCPNODELAY_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_TCPNODELAY_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_CLIENT_TCPNODELAY_KEY]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_LOW_LATENCY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable low-latency connections from the client]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_LOW_LATENCY_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value of IPC_CLIENT_LOW_LATENCY]]>
- </doc>
- </field>
- <field name="IPC_SERVER_LISTEN_QUEUE_SIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_SERVER_LISTEN_QUEUE_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_SERVER_LISTEN_QUEUE_SIZE_KEY]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_KILL_MAX_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_KILL_MAX_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_CLIENT_KILL_MAX_KEY]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_IDLETHRESHOLD_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_CLIENT_IDLETHRESHOLD_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_CLIENT_IDLETHRESHOLD_DEFAULT]]>
- </doc>
- </field>
- <field name="IPC_SERVER_TCPNODELAY_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_SERVER_TCPNODELAY_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_SERVER_TCPNODELAY_KEY]]>
- </doc>
- </field>
- <field name="IPC_SERVER_MAX_CONNECTIONS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="IPC_SERVER_MAX_CONNECTIONS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IPC_SERVER_MAX_CONNECTIONS_KEY]]>
- </doc>
- </field>
- <field name="IPC_SERVER_LOG_SLOW_RPC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Logs if a RPC is really slow compared to rest of RPCs.]]>
- </doc>
- </field>
- <field name="IPC_SERVER_LOG_SLOW_RPC_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_RPC_SOCKET_FACTORY_CLASS_DEFAULT_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_RPC_SOCKET_FACTORY_CLASS_DEFAULT_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SOCKS_SERVER_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_UTIL_HASH_TYPE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_UTIL_HASH_TYPE_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for HADOOP_UTIL_HASH_TYPE_KEY]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUP_MAPPING" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUPS_CACHE_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUPS_CACHE_SECS_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUPS_NEGATIVE_CACHE_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUPS_NEGATIVE_CACHE_SECS_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUPS_CACHE_WARN_AFTER_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUPS_CACHE_WARN_AFTER_MS_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SECURITY_GROUPS_CACHE_BACKGROUND_RELOAD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUPS_CACHE_BACKGROUND_RELOAD_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUPS_CACHE_BACKGROUND_RELOAD_THREADS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUPS_CACHE_BACKGROUND_RELOAD_THREADS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUP_SHELL_COMMAND_TIMEOUT_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUP_SHELL_COMMAND_TIMEOUT_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="use
- {@link CommonConfigurationKeysPublic#HADOOP_SECURITY_GROUP_SHELL_COMMAND_TIMEOUT_KEY}
- instead.">
- <doc>
- <![CDATA[@deprecated use
- {@link CommonConfigurationKeysPublic#HADOOP_SECURITY_GROUP_SHELL_COMMAND_TIMEOUT_KEY}
- instead.]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUP_SHELL_COMMAND_TIMEOUT_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_GROUP_SHELL_COMMAND_TIMEOUT_SECS_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="use
- {@link CommonConfigurationKeysPublic#HADOOP_SECURITY_GROUP_SHELL_COMMAND_TIMEOUT_DEFAULT}
- instead.">
- <doc>
- <![CDATA[@deprecated use
- {@link CommonConfigurationKeysPublic#HADOOP_SECURITY_GROUP_SHELL_COMMAND_TIMEOUT_DEFAULT}
- instead.]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_AUTHENTICATION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_AUTHORIZATION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_INSTRUMENTATION_REQUIRES_ADMIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_SERVICE_USER_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_AUTH_TO_LOCAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_DNS_INTERFACE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_DNS_NAMESERVER_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_TOKEN_FILES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_HTTP_AUTHENTICATION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SSL_ENABLED_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SSL_ENABLED_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_KERBEROS_MIN_SECONDS_BEFORE_RELOGIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_KERBEROS_MIN_SECONDS_BEFORE_RELOGIN_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for HADOOP_KERBEROS_MIN_SECONDS_BEFORE_RELOGIN]]>
- </doc>
- </field>
- <field name="HTTP_POLICY_HTTP_ONLY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HTTP_POLICY_HTTPS_ONLY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_RPC_PROTECTION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_SASL_PROPS_RESOLVER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Class to override Sasl Properties for a connection]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_CRYPTO_CODEC_CLASSES_KEY_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SECURITY_CRYPTO_CODEC_CLASSES_AES_CTR_NOPADDING_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SECURITY_CRYPTO_CODEC_CLASSES_AES_CTR_NOPADDING_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SECURITY_CRYPTO_CIPHER_SUITE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_CRYPTO_CIPHER_SUITE_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_CRYPTO_JCEKS_KEY_SERIALFILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_CRYPTO_BUFFER_SIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_CRYPTO_BUFFER_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Defalt value for HADOOP_SECURITY_CRYPTO_BUFFER_SIZE_KEY]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_IMPERSONATION_PROVIDER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Class to override Impersonation provider]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_KEY_PROVIDER_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_KEY_DEFAULT_BITLENGTH_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_KEY_DEFAULT_BITLENGTH_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Defalt value for HADOOP_SECURITY_KEY_DEFAULT_BITLENGTH_KEY.]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_KEY_DEFAULT_CIPHER_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_KEY_DEFAULT_CIPHER_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Defalt value for HADOOP_SECURITY_KEY_DEFAULT_CIPHER_KEY.]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_ENC_KEY_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_ENC_KEY_CACHE_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for KMS_CLIENT_ENC_KEY_CACHE_SIZE]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_ENC_KEY_CACHE_LOW_WATERMARK" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_ENC_KEY_CACHE_LOW_WATERMARK_DEFAULT" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for KMS_CLIENT_ENC_KEY_CACHE_LOW_WATERMARK]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_ENC_KEY_CACHE_NUM_REFILL_THREADS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_ENC_KEY_CACHE_NUM_REFILL_THREADS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for KMS_CLIENT_ENC_KEY_NUM_REFILL_THREADS]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_ENC_KEY_CACHE_EXPIRY_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_ENC_KEY_CACHE_EXPIRY_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for KMS_CLIENT_ENC_KEY_CACHE_EXPIRY (12 hrs)]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_TIMEOUT_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_TIMEOUT_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KMS_CLIENT_FAILOVER_MAX_RETRIES_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value is the number of providers specified.]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_FAILOVER_SLEEP_BASE_MILLIS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_FAILOVER_SLEEP_BASE_MILLIS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value is 100 ms.]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_FAILOVER_SLEEP_MAX_MILLIS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="KMS_CLIENT_FAILOVER_SLEEP_MAX_MILLIS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value is 2 secs.]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_JAVA_SECURE_RANDOM_ALGORITHM_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_JAVA_SECURE_RANDOM_ALGORITHM_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Defalt value for HADOOP_SECURITY_JAVA_SECURE_RANDOM_ALGORITHM_KEY]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_SECURE_RANDOM_IMPL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_SECURE_RANDOM_DEVICE_FILE_PATH_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_SECURE_RANDOM_DEVICE_FILE_PATH_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SHELL_MISSING_DEFAULT_FS_WARNING_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SHELL_MISSING_DEFAULT_FS_WARNING_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SHELL_SAFELY_DELETE_LIMIT_NUM_FILES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SHELL_SAFELY_DELETE_LIMIT_NUM_FILES_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_HTTP_LOGS_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_HTTP_LOGS_ENABLED_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Defalt value for HADOOP_HTTP_LOGS_ENABLED]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_CREDENTIAL_PROVIDER_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_CREDENTIAL_CLEAR_TEXT_FALLBACK" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_CREDENTIAL_CLEAR_TEXT_FALLBACK_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SECURITY_CREDENTIAL_PASSWORD_FILE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_SENSITIVE_CONFIG_KEYS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
- core-default.xml</a>]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_SENSITIVE_CONFIG_KEYS_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SERVICE_SHUTDOWN_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configuration option for the shutdown hook manager shutdown time:
- {@value}.]]>
- </doc>
- </field>
- <field name="SERVICE_SHUTDOWN_TIMEOUT_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default shutdown hook timeout: {@value} seconds.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This class contains constants for configuration keys used
- in the common code.
- It includes all publicly documented configuration keys. In general
- this class should not be used directly (use CommonConfigurationKeys
- instead)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.CommonConfigurationKeysPublic -->
- <!-- start class org.apache.hadoop.fs.ContentSummary -->
- <class name="ContentSummary" extends="org.apache.hadoop.fs.QuotaUsage"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="ContentSummary"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor deprecated by ContentSummary.Builder]]>
- </doc>
- </constructor>
- <constructor name="ContentSummary" type="long, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor, deprecated by ContentSummary.Builder
- This constructor implicitly set spaceConsumed the same as length.
- spaceConsumed and length must be set explicitly with
- ContentSummary.Builder]]>
- </doc>
- </constructor>
- <constructor name="ContentSummary" type="long, long, long, long, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor, deprecated by ContentSummary.Builder]]>
- </doc>
- </constructor>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the length]]>
- </doc>
- </method>
- <method name="getSnapshotLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDirectoryCount" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the directory count]]>
- </doc>
- </method>
- <method name="getSnapshotDirectoryCount" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFileCount" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the file count]]>
- </doc>
- </method>
- <method name="getSnapshotFileCount" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSnapshotSpaceConsumed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="to" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHeader" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="qOption" type="boolean"/>
- <doc>
- <![CDATA[Return the header of the output.
- if qOption is false, output directory count, file count, and content size;
- if qOption is true, output quota and remaining quota as well.
-
- @param qOption a flag indicating if quota needs to be printed or not
- @return the header of the output]]>
- </doc>
- </method>
- <method name="getHeaderFields" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the names of the fields from the summary header.
-
- @return names of fields as displayed in the header]]>
- </doc>
- </method>
- <method name="getQuotaHeaderFields" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the names of the fields used in the quota summary.
-
- @return names of quota fields as displayed in the header]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="qOption" type="boolean"/>
- <doc>
- <![CDATA[Return the string representation of the object in the output format.
- if qOption is false, output directory count, file count, and content size;
- if qOption is true, output quota and remaining quota as well.
- @param qOption a flag indicating if quota needs to be printed or not
- @return the string representation of the object]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="qOption" type="boolean"/>
- <param name="hOption" type="boolean"/>
- <doc>
- <![CDATA[Return the string representation of the object in the output format.
- For description of the options,
- @see #toString(boolean, boolean, boolean, boolean, List)
-
- @param qOption a flag indicating if quota needs to be printed or not
- @param hOption a flag indicating if human readable output if to be used
- @return the string representation of the object]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="qOption" type="boolean"/>
- <param name="hOption" type="boolean"/>
- <param name="xOption" type="boolean"/>
- <doc>
- <![CDATA[Return the string representation of the object in the output format.
- For description of the options,
- @see #toString(boolean, boolean, boolean, boolean, List)
- @param qOption a flag indicating if quota needs to be printed or not
- @param hOption a flag indicating if human readable output is to be used
- @param xOption a flag indicating if calculation from snapshots is to be
- included in the output
- @return the string representation of the object]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="qOption" type="boolean"/>
- <param name="hOption" type="boolean"/>
- <param name="tOption" type="boolean"/>
- <param name="types" type="java.util.List"/>
- <doc>
- <![CDATA[Return the string representation of the object in the output format.
- For description of the options,
- @see #toString(boolean, boolean, boolean, boolean, List)
- @param qOption a flag indicating if quota needs to be printed or not
- @param hOption a flag indicating if human readable output if to be used
- @param tOption a flag indicating if display quota by storage types
- @param types Storage types to display
- @return the string representation of the object]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="qOption" type="boolean"/>
- <param name="hOption" type="boolean"/>
- <param name="tOption" type="boolean"/>
- <param name="xOption" type="boolean"/>
- <param name="types" type="java.util.List"/>
- <doc>
- <![CDATA[Return the string representation of the object in the output format.
- if qOption is false, output directory count, file count, and content size;
- if qOption is true, output quota and remaining quota as well.
- if hOption is false, file sizes are returned in bytes
- if hOption is true, file sizes are returned in human readable
- if tOption is true, display the quota by storage types
- if tOption is false, same logic with #toString(boolean,boolean)
- if xOption is false, output includes the calculation from snapshots
- if xOption is true, output excludes the calculation from snapshots
- @param qOption a flag indicating if quota needs to be printed or not
- @param hOption a flag indicating if human readable output is to be used
- @param tOption a flag indicating if display quota by storage types
- @param xOption a flag indicating if calculation from snapshots is to be
- included in the output
- @param types Storage types to display
- @return the string representation of the object]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Store the summary of a content (a directory or a file).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ContentSummary -->
- <!-- start class org.apache.hadoop.fs.CreateFlag -->
- <class name="CreateFlag" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.CreateFlag[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.CreateFlag"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="validate"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="flag" type="java.util.EnumSet"/>
- <doc>
- <![CDATA[Validate the CreateFlag and throw exception if it is invalid
- @param flag set of CreateFlag
- @throws HadoopIllegalArgumentException if the CreateFlag is invalid]]>
- </doc>
- </method>
- <method name="validate"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.Object"/>
- <param name="pathExists" type="boolean"/>
- <param name="flag" type="java.util.EnumSet"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Validate the CreateFlag for create operation
- @param path Object representing the path; usually String or {@link Path}
- @param pathExists pass true if the path exists in the file system
- @param flag set of CreateFlag
- @throws IOException on error
- @throws HadoopIllegalArgumentException if the CreateFlag is invalid]]>
- </doc>
- </method>
- <method name="validateForAppend"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="flag" type="java.util.EnumSet"/>
- <doc>
- <![CDATA[Validate the CreateFlag for the append operation. The flag must contain
- APPEND, and cannot contain OVERWRITE.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[CreateFlag specifies the file create semantic. Users can combine flags like: <br>
- <code>
- EnumSet.of(CreateFlag.CREATE, CreateFlag.APPEND)
- <code>
- <p>
-
- Use the CreateFlag as follows:
- <ol>
- <li> CREATE - to create a file if it does not exist,
- else throw FileAlreadyExists.</li>
- <li> APPEND - to append to a file if it exists,
- else throw FileNotFoundException.</li>
- <li> OVERWRITE - to truncate a file if it exists,
- else throw FileNotFoundException.</li>
- <li> CREATE|APPEND - to create a file if it does not exist,
- else append to an existing file.</li>
- <li> CREATE|OVERWRITE - to create a file if it does not exist,
- else overwrite an existing file.</li>
- <li> SYNC_BLOCK - to force closed blocks to the disk device.
- In addition {@link Syncable#hsync()} should be called after each write,
- if true synchronous behavior is required.</li>
- <li> LAZY_PERSIST - Create the block on transient storage (RAM) if
- available.</li>
- <li> APPEND_NEWBLOCK - Append data to a new block instead of end of the last
- partial block.</li>
- </ol>
-
- Following combinations are not valid and will result in
- {@link HadoopIllegalArgumentException}:
- <ol>
- <li> APPEND|OVERWRITE</li>
- <li> CREATE|APPEND|OVERWRITE</li>
- </ol>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.CreateFlag -->
- <!-- start class org.apache.hadoop.fs.FileAlreadyExistsException -->
- <class name="FileAlreadyExistsException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileAlreadyExistsException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FileAlreadyExistsException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Used when target file already exists for any operation and
- is not configured to be overwritten.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileAlreadyExistsException -->
- <!-- start class org.apache.hadoop.fs.FileChecksum -->
- <class name="FileChecksum" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="FileChecksum"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAlgorithmName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The checksum algorithm name]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The length of the checksum in bytes]]>
- </doc>
- </method>
- <method name="getBytes" return="byte[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The value of the checksum in bytes]]>
- </doc>
- </method>
- <method name="getChecksumOpt" return="org.apache.hadoop.fs.Options.ChecksumOpt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- <doc>
- <![CDATA[Return true if both the algorithms and the values are the same.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[An abstract class representing file checksums for files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileChecksum -->
- <!-- start class org.apache.hadoop.fs.FileContext -->
- <class name="FileContext" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getFSofPath" return="org.apache.hadoop.fs.AbstractFileSystem"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="absOrFqPath" type="org.apache.hadoop.fs.Path"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the file system of supplied path.
-
- @param absOrFqPath - absolute or fully qualified path
- @return the file system of the path
-
- @throws UnsupportedFileSystemException If the file system for
- <code>absOrFqPath</code> is not supported.
- @throws IOException If the file system for <code>absOrFqPath</code> could
- not be instantiated.]]>
- </doc>
- </method>
- <method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="defFS" type="org.apache.hadoop.fs.AbstractFileSystem"/>
- <param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Create a FileContext with specified FS as default using the specified
- config.
-
- @param defFS
- @param aConf
- @return new FileContext with specifed FS as default.]]>
- </doc>
- </method>
- <method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="defaultFS" type="org.apache.hadoop.fs.AbstractFileSystem"/>
- <doc>
- <![CDATA[Create a FileContext for specified file system using the default config.
-
- @param defaultFS
- @return a FileContext with the specified AbstractFileSystem
- as the default FS.]]>
- </doc>
- </method>
- <method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <doc>
- <![CDATA[Create a FileContext using the default config read from the
- $HADOOP_CONFIG/core.xml, Unspecified key-values for config are defaulted
- from core-defaults.xml in the release jar.
-
- @throws UnsupportedFileSystemException If the file system from the default
- configuration is not supported]]>
- </doc>
- </method>
- <method name="getLocalFSFileContext" return="org.apache.hadoop.fs.FileContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <doc>
- <![CDATA[@return a FileContext for the local file system using the default config.
- @throws UnsupportedFileSystemException If the file system for
- {@link FsConstants#LOCAL_FS_URI} is not supported.]]>
- </doc>
- </method>
- <method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="defaultFsUri" type="java.net.URI"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <doc>
- <![CDATA[Create a FileContext for specified URI using the default config.
-
- @param defaultFsUri
- @return a FileContext with the specified URI as the default FS.
-
- @throws UnsupportedFileSystemException If the file system for
- <code>defaultFsUri</code> is not supported]]>
- </doc>
- </method>
- <method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="defaultFsUri" type="java.net.URI"/>
- <param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <doc>
- <![CDATA[Create a FileContext for specified default URI using the specified config.
-
- @param defaultFsUri
- @param aConf
- @return new FileContext for specified uri
- @throws UnsupportedFileSystemException If the file system with specified is
- not supported
- @throws RuntimeException If the file system specified is supported but
- could not be instantiated, or if login fails.]]>
- </doc>
- </method>
- <method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <doc>
- <![CDATA[Create a FileContext using the passed config. Generally it is better to use
- {@link #getFileContext(URI, Configuration)} instead of this one.
-
-
- @param aConf
- @return new FileContext
- @throws UnsupportedFileSystemException If file system in the config
- is not supported]]>
- </doc>
- </method>
- <method name="getLocalFSFileContext" return="org.apache.hadoop.fs.FileContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <doc>
- <![CDATA[@param aConf - from which the FileContext is configured
- @return a FileContext for the local file system using the specified config.
-
- @throws UnsupportedFileSystemException If default file system in the config
- is not supported]]>
- </doc>
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newWDir" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the working directory for wd-relative names (such a "foo/bar"). Working
- directory feature is provided by simply prefixing relative names with the
- working dir. Note this is different from Unix where the wd is actually set
- to the inode. Hence setWorkingDir does not follow symlinks etc. This works
- better in a distributed environment that has multiple independent roots.
- {@link #getWorkingDirectory()} should return what setWorkingDir() set.
-
- @param newWDir new working directory
- @throws IOException
- <br>
- NewWdir can be one of:
- <ul>
- <li>relative path: "foo/bar";</li>
- <li>absolute without scheme: "/foo/bar"</li>
- <li>fully qualified with scheme: "xx://auth/foo/bar"</li>
- </ul>
- <br>
- Illegal WDs:
- <ul>
- <li>relative with scheme: "xx:foo/bar"</li>
- <li>non existent directory</li>
- </ul>]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Gets the working directory for wd-relative names (such a "foo/bar").]]>
- </doc>
- </method>
- <method name="getUgi" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Gets the ugi in the file-context
- @return UserGroupInformation]]>
- </doc>
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the current user's home directory in this file system.
- The default implementation returns "/user/$USER/".
- @return the home directory]]>
- </doc>
- </method>
- <method name="getUMask" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the umask of this FileContext]]>
- </doc>
- </method>
- <method name="setUMask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newUmask" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <doc>
- <![CDATA[Set umask to the supplied parameter.
- @param newUmask the new umask]]>
- </doc>
- </method>
- <method name="resolvePath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Resolve the path following any symlinks or mount points
- @param f to be resolved
- @return fully qualified resolved path
-
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws AccessControlException if access denied
- @throws IOException If an IO Error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server
-
- RuntimeExceptions:
- @throws InvalidPathException If path <code>f</code> is not valid]]>
- </doc>
- </method>
- <method name="makeQualified" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Make the path fully qualified if it is isn't.
- A Fully-qualified path has scheme and authority specified and an absolute
- path.
- Use the default file system and working dir in this FileContext to qualify.
- @param path
- @return qualified path]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="createFlag" type="java.util.EnumSet"/>
- <param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create or overwrite file on indicated path and returns an output stream for
- writing into the file.
-
- @param f the file name to open
- @param createFlag gives the semantics of create; see {@link CreateFlag}
- @param opts file creation options; see {@link Options.CreateOpts}.
- <ul>
- <li>Progress - to report progress on the operation - default null
- <li>Permission - umask is applied against permisssion: default is
- FsPermissions:getDefault()
-
- <li>CreateParent - create missing parent path; default is to not
- to create parents
- <li>The defaults for the following are SS defaults of the file
- server implementing the target path. Not all parameters make sense
- for all kinds of file system - eg. localFS ignores Blocksize,
- replication, checksum
- <ul>
- <li>BufferSize - buffersize used in FSDataOutputStream
- <li>Blocksize - block size for file blocks
- <li>ReplicationFactor - replication for blocks
- <li>ChecksumParam - Checksum parameters. server default is used
- if not specified.
- </ul>
- </ul>
-
- @return {@link FSDataOutputStream} for created file
-
- @throws AccessControlException If access is denied
- @throws FileAlreadyExistsException If file <code>f</code> already exists
- @throws FileNotFoundException If parent of <code>f</code> does not exist
- and <code>createParent</code> is false
- @throws ParentNotDirectoryException If parent of <code>f</code> is not a
- directory.
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server
-
- RuntimeExceptions:
- @throws InvalidPathException If path <code>f</code> is not valid]]>
- </doc>
- </method>
- <method name="mkdir"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="createParent" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make(create) a directory and all the non-existent parents.
-
- @param dir - the dir to make
- @param permission - permissions is set permission&~umask
- @param createParent - if true then missing parent dirs are created if false
- then parent must exist
-
- @throws AccessControlException If access is denied
- @throws FileAlreadyExistsException If directory <code>dir</code> already
- exists
- @throws FileNotFoundException If parent of <code>dir</code> does not exist
- and <code>createParent</code> is false
- @throws ParentNotDirectoryException If parent of <code>dir</code> is not a
- directory
- @throws UnsupportedFileSystemException If file system for <code>dir</code>
- is not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server
-
- RuntimeExceptions:
- @throws InvalidPathException If path <code>dir</code> is not valid]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete a file.
- @param f the path to delete.
- @param recursive if path is a directory and set to
- true, the directory is deleted else throws an exception. In
- case of a file the recursive can be set to either true or false.
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server
-
- RuntimeExceptions:
- @throws InvalidPathException If path <code>f</code> is invalid]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataInputStream at the indicated Path using
- default buffersize.
- @param f the file name to open
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If file <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code>
- is not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataInputStream at the indicated Path.
-
- @param f the file name to open
- @param bufferSize the size of the buffer to be used.
-
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If file <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="truncate" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="newLength" type="long"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Truncate the file in the indicated path to the indicated size.
- <ul>
- <li>Fails if path is a directory.
- <li>Fails if path does not exist.
- <li>Fails if path is not closed.
- <li>Fails if new size is greater than current size.
- </ul>
- @param f The path to the file to be truncated
- @param newLength The size the file is to be truncated to
- @return <code>true</code> if the file has been truncated to the desired
- <code>newLength</code> and is immediately available to be reused for
- write operations such as <code>append</code>, or
- <code>false</code> if a background process of adjusting the length of
- the last block has been started, and clients should wait for it to
- complete before proceeding with further file updates.
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If file <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set replication for an existing file.
-
- @param f file name
- @param replication new replication
- @return true if successful
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If file <code>f</code> does not exist
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="rename"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="options" type="org.apache.hadoop.fs.Options.Rename[]"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Renames Path src to Path dst
- <ul>
- <li
- <li>Fails if src is a file and dst is a directory.
- <li>Fails if src is a directory and dst is a file.
- <li>Fails if the parent of dst does not exist or is a file.
- </ul>
- <p>
- If OVERWRITE option is not passed as an argument, rename fails if the dst
- already exists.
- <p>
- If OVERWRITE option is passed as an argument, rename overwrites the dst if
- it is a file or an empty directory. Rename fails if dst is a non-empty
- directory.
- <p>
- Note that atomicity of rename is dependent on the file system
- implementation. Please refer to the file system documentation for details
- <p>
-
- @param src path to be renamed
- @param dst new path after rename
-
- @throws AccessControlException If access is denied
- @throws FileAlreadyExistsException If <code>dst</code> already exists and
- <code>options</options> has {@link Options.Rename#OVERWRITE}
- option false.
- @throws FileNotFoundException If <code>src</code> does not exist
- @throws ParentNotDirectoryException If parent of <code>dst</code> is not a
- directory
- @throws UnsupportedFileSystemException If file system for <code>src</code>
- and <code>dst</code> is not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set permission of a path.
- @param f
- @param permission - the new absolute permission (umask is not applied)
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code>
- is not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set owner of a path (i.e. a file or a directory). The parameters username
- and groupname cannot both be null.
-
- @param f The path
- @param username If it is null, the original username remains unchanged.
- @param groupname If it is null, the original groupname remains unchanged.
-
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server
-
- RuntimeExceptions:
- @throws HadoopIllegalArgumentException If <code>username</code> or
- <code>groupname</code> is invalid.]]>
- </doc>
- </method>
- <method name="setTimes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="mtime" type="long"/>
- <param name="atime" type="long"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set access time of a file.
- @param f The path
- @param mtime Set the modification time of this file.
- The number of milliseconds since epoch (Jan 1, 1970).
- A value of -1 means that this call should not set modification time.
- @param atime Set the access time of this file.
- The number of milliseconds since Jan 1, 1970.
- A value of -1 means that this call should not set access time.
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the checksum of a file.
- @param f file path
- @return The file checksum. The default return value is null,
- which indicates that no checksum algorithm is implemented
- in the corresponding FileSystem.
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="setVerifyChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the verify checksum flag for the file system denoted by the path.
- This is only applicable if the
- corresponding FileSystem supports checksum. By default doesn't do anything.
- @param verifyChecksum
- @param f set the verifyChecksum for the Filesystem containing this path
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a file status object that represents the path.
- @param f The path we want information from
- @return a FileStatus object
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a file status object that represents the path. If the path
- refers to a symlink then the FileStatus of the symlink is returned.
- The behavior is equivalent to #getFileStatus() if the underlying
- file system does not support symbolic links.
- @param f The path we want information from.
- @return A FileStatus object
-
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred]]>
- </doc>
- </method>
- <method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the target of the given symbolic link as it was specified
- when the link was created. Links in the path leading up to the
- final path component are resolved transparently.
- @param f the path to return the target of
- @return The un-interpreted target of the symbolic link.
-
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If path <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If the given path does not refer to a symlink
- or an I/O error occurred]]>
- </doc>
- </method>
- <method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a status object describing the use and capacity of the
- file system denoted by the Parh argument p.
- If the file system has multiple partitions, the
- use and capacity of the partition pointed to by the specified
- path is reflected.
-
- @param f Path for which status should be obtained. null means the
- root partition of the default file system.
- @return a FsStatus object
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="createSymlink"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="org.apache.hadoop.fs.Path"/>
- <param name="link" type="org.apache.hadoop.fs.Path"/>
- <param name="createParent" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates a symbolic link to an existing file. An exception is thrown if
- the symlink exits, the user does not have permission to create symlink,
- or the underlying file system does not support symlinks.
-
- Symlink permissions are ignored, access to a symlink is determined by
- the permissions of the symlink target.
-
- Symlinks in paths leading up to the final path component are resolved
- transparently. If the final path component refers to a symlink some
- functions operate on the symlink itself, these are:
- - delete(f) and deleteOnExit(f) - Deletes the symlink.
- - rename(src, dst) - If src refers to a symlink, the symlink is
- renamed. If dst refers to a symlink, the symlink is over-written.
- - getLinkTarget(f) - Returns the target of the symlink.
- - getFileLinkStatus(f) - Returns a FileStatus object describing
- the symlink.
- Some functions, create() and mkdir(), expect the final path component
- does not exist. If they are given a path that refers to a symlink that
- does exist they behave as if the path referred to an existing file or
- directory. All other functions fully resolve, ie follow, the symlink.
- These are: open, setReplication, setOwner, setTimes, setWorkingDirectory,
- setPermission, getFileChecksum, setVerifyChecksum, getFileBlockLocations,
- getFsStatus, getFileStatus, exists, and listStatus.
-
- Symlink targets are stored as given to createSymlink, assuming the
- underlying file system is capable of storing a fully qualified URI.
- Dangling symlinks are permitted. FileContext supports four types of
- symlink targets, and resolves them as follows
- <pre>
- Given a path referring to a symlink of form:
-
- <---X--->
- fs://host/A/B/link
- <-----Y----->
-
- In this path X is the scheme and authority that identify the file system,
- and Y is the path leading up to the final path component "link". If Y is
- a symlink itself then let Y' be the target of Y and X' be the scheme and
- authority of Y'. Symlink targets may:
-
- 1. Fully qualified URIs
-
- fs://hostX/A/B/file Resolved according to the target file system.
-
- 2. Partially qualified URIs (eg scheme but no host)
-
- fs:///A/B/file Resolved according to the target file system. Eg resolving
- a symlink to hdfs:///A results in an exception because
- HDFS URIs must be fully qualified, while a symlink to
- file:///A will not since Hadoop's local file systems
- require partially qualified URIs.
-
- 3. Relative paths
-
- path Resolves to [Y'][path]. Eg if Y resolves to hdfs://host/A and path
- is "../B/file" then [Y'][path] is hdfs://host/B/file
-
- 4. Absolute paths
-
- path Resolves to [X'][path]. Eg if Y resolves hdfs://host/A/B and path
- is "/file" then [X][path] is hdfs://host/file
- </pre>
-
- @param target the target of the symbolic link
- @param link the path to be created that points to target
- @param createParent if true then missing parent dirs are created if
- false then parent must exist
- @throws AccessControlException If access is denied
- @throws FileAlreadyExistsException If file <code>linkcode> already exists
- @throws FileNotFoundException If <code>target</code> does not exist
- @throws ParentNotDirectoryException If parent of <code>link</code> is not a
- directory.
- @throws UnsupportedFileSystemException If file system for
- <code>target</code> or <code>link</code> is not supported
- @throws IOException If an I/O error occurred]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List the statuses of the files/directories in the given path if the path is
- a directory.
-
- @param f is the path
- @return an iterator that traverses statuses of the files/directories
- in the given path
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="listCorruptFileBlocks" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return an iterator over the corrupt files under the given path
- (may contain duplicates if a file has more than one corrupt block)
- @throws IOException]]>
- </doc>
- </method>
- <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List the statuses of the files/directories in the given path if the path is
- a directory.
- Return the file's status and block locations If the path is a file.
-
- If a returned status is a file, it contains the file's block locations.
-
- @param f is the path
- @return an iterator that traverses statuses of the files/directories
- in the given path
- If any IO exception (for example the input directory gets deleted while
- listing is being executed), next() or hasNext() of the returned iterator
- may throw a RuntimeException with the io exception as the cause.
- @throws AccessControlException If access is denied
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="deleteOnExit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark a path to be deleted on JVM shutdown.
-
- @param f the existing path to delete.
- @return true if deleteOnExit is successful, otherwise false.
- @throws AccessControlException If access is denied
- @throws UnsupportedFileSystemException If file system for <code>f</code> is
- not supported
- @throws IOException If an I/O error occurred
-
- Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="util" return="org.apache.hadoop.fs.FileContext.Util"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="resolve" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Resolves all symbolic links in the specified path.
- Returns the new path object.]]>
- </doc>
- </method>
- <method name="resolveIntermediate" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Resolves all symbolic links in the specified path leading up
- to, but not including the final path component.
- @param f path to resolve
- @return the new path object.]]>
- </doc>
- </method>
- <method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <doc>
- <![CDATA[Get the statistics for a particular file system
-
- @param uri
- the uri to lookup the statistics. Only scheme and authority part
- of the uri are used as the key to store and lookup.
- @return a statistics object]]>
- </doc>
- </method>
- <method name="clearStatistics"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clears all the statistics stored in AbstractFileSystem, for all the file
- systems.]]>
- </doc>
- </method>
- <method name="printStatistics"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prints the statistics to standard output. File System is identified by the
- scheme and authority.]]>
- </doc>
- </method>
- <method name="getAllStatistics" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Map of uri and statistics for each filesystem instantiated. The uri
- consists of scheme and authority for the filesystem.]]>
- </doc>
- </method>
- <method name="modifyAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Modifies ACL entries of files and directories. This method can add new ACL
- entries or modify the permissions on existing ACL entries. All existing
- ACL entries that are not specified in this call are retained without
- changes. (Modifications are merged into the current ACL.)
- @param path Path to modify
- @param aclSpec List<AclEntry> describing modifications
- @throws IOException if an ACL could not be modified]]>
- </doc>
- </method>
- <method name="removeAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Removes ACL entries from files and directories. Other ACL entries are
- retained.
- @param path Path to modify
- @param aclSpec List<AclEntry> describing entries to remove
- @throws IOException if an ACL could not be modified]]>
- </doc>
- </method>
- <method name="removeDefaultAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Removes all default ACL entries from files and directories.
- @param path Path to modify
- @throws IOException if an ACL could not be modified]]>
- </doc>
- </method>
- <method name="removeAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Removes all but the base ACL entries of files and directories. The entries
- for user, group, and others are retained for compatibility with permission
- bits.
- @param path Path to modify
- @throws IOException if an ACL could not be removed]]>
- </doc>
- </method>
- <method name="setAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fully replaces ACL of files and directories, discarding all existing
- entries.
- @param path Path to modify
- @param aclSpec List<AclEntry> describing modifications, must include entries
- for user, group, and others for compatibility with permission bits.
- @throws IOException if an ACL could not be modified]]>
- </doc>
- </method>
- <method name="getAclStatus" return="org.apache.hadoop.fs.permission.AclStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the ACLs of files and directories.
- @param path Path to get
- @return RemoteIterator<AclStatus> which returns each AclStatus
- @throws IOException if an ACL could not be read]]>
- </doc>
- </method>
- <method name="setXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set an xattr of a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to modify
- @param name xattr name.
- @param value xattr value.
- @throws IOException]]>
- </doc>
- </method>
- <method name="setXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="byte[]"/>
- <param name="flag" type="java.util.EnumSet"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set an xattr of a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to modify
- @param name xattr name.
- @param value xattr value.
- @param flag xattr set flag
- @throws IOException]]>
- </doc>
- </method>
- <method name="getXAttr" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get an xattr for a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attribute
- @param name xattr name.
- @return byte[] xattr value.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all of the xattrs for a file or directory.
- Only those xattrs for which the logged-in user has permissions to view
- are returned.
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attributes
- @return Map<String, byte[]> describing the XAttrs of the file or directory
- @throws IOException]]>
- </doc>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="names" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all of the xattrs for a file or directory.
- Only those xattrs for which the logged-in user has permissions to view
- are returned.
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attributes
- @param names XAttr names.
- @return Map<String, byte[]> describing the XAttrs of the file or directory
- @throws IOException]]>
- </doc>
- </method>
- <method name="removeXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Remove an xattr of a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to remove extended attribute
- @param name xattr name
- @throws IOException]]>
- </doc>
- </method>
- <method name="listXAttrs" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all of the xattr names for a file or directory.
- Only those xattr names which the logged-in user has permissions to view
- are returned.
- <p/>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attributes
- @return List<String> of the XAttr names of the file or directory
- @throws IOException]]>
- </doc>
- </method>
- <method name="createSnapshot" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a snapshot with a default name.
- @param path The directory where snapshots will be taken.
- @return the snapshot path.
- @throws IOException If an I/O error occurred
- <p>Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="createSnapshot" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a snapshot.
- @param path The directory where snapshots will be taken.
- @param snapshotName The name of the snapshot
- @return the snapshot path.
- @throws IOException If an I/O error occurred
- <p>Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="renameSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotOldName" type="java.lang.String"/>
- <param name="snapshotNewName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Rename a snapshot.
- @param path The directory path where the snapshot was taken
- @param snapshotOldName Old name of the snapshot
- @param snapshotNewName New name of the snapshot
- @throws IOException If an I/O error occurred
- <p>Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="deleteSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete a snapshot of a directory.
- @param path The directory that the to-be-deleted snapshot belongs to
- @param snapshotName The name of the snapshot
- @throws IOException If an I/O error occurred
- <p>Exceptions applicable to file systems accessed over RPC:
- @throws RpcClientException If an exception occurred in the RPC client
- @throws RpcServerException If an exception occurred in the RPC server
- @throws UnexpectedServerException If server implementation throws
- undeclared exception to RPC server]]>
- </doc>
- </method>
- <method name="setStoragePolicy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="policyName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the storage policy for a given file or directory.
- @param path file or directory path.
- @param policyName the name of the target storage policy. The list
- of supported Storage policies can be retrieved
- via {@link #getAllStoragePolicies}.]]>
- </doc>
- </method>
- <method name="unsetStoragePolicy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Unset the storage policy set for a given file or directory.
- @param src file or directory path.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getStoragePolicy" return="org.apache.hadoop.fs.BlockStoragePolicySpi"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Query the effective storage policy ID for the given file or directory.
- @param path file or directory path.
- @return storage policy for give file.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getAllStoragePolicies" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Retrieve all the storage policies supported by this file system.
- @return all storage policies supported by this filesystem.
- @throws IOException]]>
- </doc>
- </method>
- <field name="LOG" type="org.slf4j.Logger"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_PERM" type="org.apache.hadoop.fs.permission.FsPermission"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default permission for directory and symlink
- In previous versions, this default permission was also used to
- create files, so files created end up with ugo+x permission.
- See HADOOP-9155 for detail.
- Two new constants are added to solve this, please use
- {@link FileContext#DIR_DEFAULT_PERM} for directory, and use
- {@link FileContext#FILE_DEFAULT_PERM} for file.
- This constant is kept for compatibility.]]>
- </doc>
- </field>
- <field name="DIR_DEFAULT_PERM" type="org.apache.hadoop.fs.permission.FsPermission"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default permission for directory]]>
- </doc>
- </field>
- <field name="FILE_DEFAULT_PERM" type="org.apache.hadoop.fs.permission.FsPermission"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default permission for file]]>
- </doc>
- </field>
- <field name="SHUTDOWN_HOOK_PRIORITY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Priority of the FileContext shutdown hook.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The FileContext class provides an interface to the application writer for
- using the Hadoop file system.
- It provides a set of methods for the usual operation: create, open,
- list, etc
-
- <p>
- <b> *** Path Names *** </b>
- <p>
-
- The Hadoop file system supports a URI name space and URI names.
- It offers a forest of file systems that can be referenced using fully
- qualified URIs.
- Two common Hadoop file systems implementations are
- <ul>
- <li> the local file system: file:///path
- <li> the hdfs file system hdfs://nnAddress:nnPort/path
- </ul>
-
- While URI names are very flexible, it requires knowing the name or address
- of the server. For convenience one often wants to access the default system
- in one's environment without knowing its name/address. This has an
- additional benefit that it allows one to change one's default fs
- (e.g. admin moves application from cluster1 to cluster2).
- <p>
-
- To facilitate this, Hadoop supports a notion of a default file system.
- The user can set his default file system, although this is
- typically set up for you in your environment via your default config.
- A default file system implies a default scheme and authority; slash-relative
- names (such as /for/bar) are resolved relative to that default FS.
- Similarly a user can also have working-directory-relative names (i.e. names
- not starting with a slash). While the working directory is generally in the
- same default FS, the wd can be in a different FS.
- <p>
- Hence Hadoop path names can be one of:
- <ul>
- <li> fully qualified URI: scheme://authority/path
- <li> slash relative names: /path relative to the default file system
- <li> wd-relative names: path relative to the working dir
- </ul>
- Relative paths with scheme (scheme:foo/bar) are illegal.
-
- <p>
- <b>****The Role of the FileContext and configuration defaults****</b>
- <p>
- The FileContext provides file namespace context for resolving file names;
- it also contains the umask for permissions, In that sense it is like the
- per-process file-related state in Unix system.
- These two properties
- <ul>
- <li> default file system i.e your slash)
- <li> umask
- </ul>
- in general, are obtained from the default configuration file
- in your environment, (@see {@link Configuration}).
-
- No other configuration parameters are obtained from the default config as
- far as the file context layer is concerned. All file system instances
- (i.e. deployments of file systems) have default properties; we call these
- server side (SS) defaults. Operation like create allow one to select many
- properties: either pass them in as explicit parameters or use
- the SS properties.
- <p>
- The file system related SS defaults are
- <ul>
- <li> the home directory (default is "/user/userName")
- <li> the initial wd (only for local fs)
- <li> replication factor
- <li> block size
- <li> buffer size
- <li> encryptDataTransfer
- <li> checksum option. (checksumType and bytesPerChecksum)
- </ul>
- <p>
- <b> *** Usage Model for the FileContext class *** </b>
- <p>
- Example 1: use the default config read from the $HADOOP_CONFIG/core.xml.
- Unspecified values come from core-defaults.xml in the release jar.
- <ul>
- <li> myFContext = FileContext.getFileContext(); // uses the default config
- // which has your default FS
- <li> myFContext.create(path, ...);
- <li> myFContext.setWorkingDir(path)
- <li> myFContext.open (path, ...);
- </ul>
- Example 2: Get a FileContext with a specific URI as the default FS
- <ul>
- <li> myFContext = FileContext.getFileContext(URI)
- <li> myFContext.create(path, ...);
- ...
- </ul>
- Example 3: FileContext with local file system as the default
- <ul>
- <li> myFContext = FileContext.getLocalFSFileContext()
- <li> myFContext.create(path, ...);
- <li> ...
- </ul>
- Example 4: Use a specific config, ignoring $HADOOP_CONFIG
- Generally you should not need use a config unless you are doing
- <ul>
- <li> configX = someConfigSomeOnePassedToYou.
- <li> myFContext = getFileContext(configX); // configX is not changed,
- // is passed down
- <li> myFContext.create(path, ...);
- <li>...
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileContext -->
- <!-- start class org.apache.hadoop.fs.FileStatus -->
- <class name="FileStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Comparable"/>
- <constructor name="FileStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FileStatus" type="long, boolean, int, long, long, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FileStatus" type="long, boolean, int, long, long, long, org.apache.hadoop.fs.permission.FsPermission, java.lang.String, java.lang.String, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor for file systems on which symbolic links are not supported]]>
- </doc>
- </constructor>
- <constructor name="FileStatus" type="long, boolean, int, long, long, long, org.apache.hadoop.fs.permission.FsPermission, java.lang.String, java.lang.String, org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FileStatus" type="org.apache.hadoop.fs.FileStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy constructor.
- @param other FileStatus to copy]]>
- </doc>
- </constructor>
- <method name="getLen" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the length of this file, in bytes.
- @return the length of this file, in bytes.]]>
- </doc>
- </method>
- <method name="isFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is this a file?
- @return true if this is a file]]>
- </doc>
- </method>
- <method name="isDirectory" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is this a directory?
- @return true if this is a directory]]>
- </doc>
- </method>
- <method name="isDir" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link FileStatus#isFile()},
- {@link FileStatus#isDirectory()}, and {@link FileStatus#isSymlink()}
- instead.">
- <doc>
- <![CDATA[Old interface, instead use the explicit {@link FileStatus#isFile()},
- {@link FileStatus#isDirectory()}, and {@link FileStatus#isSymlink()}
- @return true if this is a directory.
- @deprecated Use {@link FileStatus#isFile()},
- {@link FileStatus#isDirectory()}, and {@link FileStatus#isSymlink()}
- instead.]]>
- </doc>
- </method>
- <method name="isSymlink" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is this a symbolic link?
- @return true if this is a symbolic link]]>
- </doc>
- </method>
- <method name="getBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the block size of the file.
- @return the number of bytes]]>
- </doc>
- </method>
- <method name="getReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the replication factor of a file.
- @return the replication factor of a file.]]>
- </doc>
- </method>
- <method name="getModificationTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the modification time of the file.
- @return the modification time of file in milliseconds since January 1, 1970 UTC.]]>
- </doc>
- </method>
- <method name="getAccessTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the access time of the file.
- @return the access time of file in milliseconds since January 1, 1970 UTC.]]>
- </doc>
- </method>
- <method name="getPermission" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get FsPermission associated with the file.
- @return permssion. If a filesystem does not have a notion of permissions
- or if permissions could not be determined, then default
- permissions equivalent of "rwxrwxrwx" is returned.]]>
- </doc>
- </method>
- <method name="isEncrypted" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Tell whether the underlying file or directory is encrypted or not.
- @return true if the underlying file is encrypted.]]>
- </doc>
- </method>
- <method name="getOwner" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the owner of the file.
- @return owner of the file. The string could be empty if there is no
- notion of owner of a file in a filesystem or if it could not
- be determined (rare).]]>
- </doc>
- </method>
- <method name="getGroup" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the group associated with the file.
- @return group for the file. The string could be empty if there is no
- notion of group of a file in a filesystem or if it could not
- be determined (rare).]]>
- </doc>
- </method>
- <method name="getPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setPath"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <doc>
- <![CDATA[Sets permission.
- @param permission if permission is null, default value is set]]>
- </doc>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="owner" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets owner.
- @param owner if it is null, default value is set]]>
- </doc>
- </method>
- <method name="setGroup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets group.
- @param group if it is null, default value is set]]>
- </doc>
- </method>
- <method name="getSymlink" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return The contents of the symbolic link.]]>
- </doc>
- </method>
- <method name="setSymlink"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.fs.FileStatus"/>
- <doc>
- <![CDATA[Compare this FileStatus to another FileStatus
- @param o the FileStatus to be compared.
- @return a negative integer, zero, or a positive integer as this object
- is less than, equal to, or greater than the specified object.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compare if this object is equal to another object
- @param o the object to be compared.
- @return true if two file status has the same path name; false if not.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a hash code value for the object, which is defined as
- the hash code of the path name.
- @return a hash code value for the path name.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Interface that represents the client side information for a file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileStatus -->
- <!-- start class org.apache.hadoop.fs.FileSystem -->
- <class name="FileSystem" extends="org.apache.hadoop.conf.Configured"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="FileSystem"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="get" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get a FileSystem instance based on the uri, the passed in
- configuration and the user.
- @param uri of the filesystem
- @param conf the configuration to use
- @param user to perform the get as
- @return the filesystem instance
- @throws IOException failure to load
- @throws InterruptedException If the {@code UGI.doAs()} call was
- somehow interrupted.]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the configured FileSystem implementation.
- @param conf the configuration to use]]>
- </doc>
- </method>
- <method name="getDefaultUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the default FileSystem URI from a configuration.
- @param conf the configuration to use
- @return the uri of the default filesystem]]>
- </doc>
- </method>
- <method name="setDefaultUri"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="uri" type="java.net.URI"/>
- <doc>
- <![CDATA[Set the default FileSystem URI in a configuration.
- @param conf the configuration to alter
- @param uri the new default filesystem uri]]>
- </doc>
- </method>
- <method name="setDefaultUri"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="uri" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the default FileSystem URI in a configuration.
- @param conf the configuration to alter
- @param uri the new default filesystem uri]]>
- </doc>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Initialize a FileSystem.
- Called after the new FileSystem instance is constructed, and before it
- is ready for use.
- FileSystem implementations overriding this method MUST forward it to
- their superclass, though the order in which it is done, and whether
- to alter the configuration before the invocation are options of the
- subclass.
- @param name a URI whose authority section names the host, port, etc.
- for this FileSystem
- @param conf the configuration
- @throws IOException on any failure to initialize this instance.
- @throws IllegalArgumentException if the URI is considered invalid.]]>
- </doc>
- </method>
- <method name="getScheme" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the protocol scheme for this FileSystem.
- <p>
- This implementation throws an <code>UnsupportedOperationException</code>.
- @return the protocol scheme for this FileSystem.
- @throws UnsupportedOperationException if the operation is unsupported
- (default).]]>
- </doc>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a URI which identifies this FileSystem.
- @return the URI of this filesystem.]]>
- </doc>
- </method>
- <method name="getCanonicalUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a canonicalized form of this FileSystem's URI.
- The default implementation simply calls {@link #canonicalizeUri(URI)}
- on the filesystem's own URI, so subclasses typically only need to
- implement that method.
- @see #canonicalizeUri(URI)]]>
- </doc>
- </method>
- <method name="canonicalizeUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <doc>
- <![CDATA[Canonicalize the given URI.
- This is implementation-dependent, and may for example consist of
- canonicalizing the hostname using DNS and adding the default
- port if not specified.
- The default implementation simply fills in the default port if
- not specified and if {@link #getDefaultPort()} returns a
- default port.
- @return URI
- @see NetUtils#getCanonicalUri(URI, int)]]>
- </doc>
- </method>
- <method name="getDefaultPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default port for this FileSystem.
- @return the default port or 0 if there isn't one]]>
- </doc>
- </method>
- <method name="getFSofPath" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="absOrFqPath" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCanonicalServiceName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a canonical service name for this FileSystem.
- The token cache is the only user of the canonical service name,
- and uses it to lookup this FileSystem's service tokens.
- If the file system provides a token of its own then it must have a canonical
- name, otherwise the canonical name can be null.
- Default implementation: If the FileSystem has child file systems
- (such as an embedded file system) then it is assumed that the FS has no
- tokens of its own and hence returns a null name; otherwise a service
- name is built using Uri and port.
- @return a service string that uniquely identifies this file system, null
- if the filesystem does not implement tokens
- @see SecurityUtil#buildDTServiceName(URI, int)]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="call {@link #getUri()} instead.">
- <doc>
- <![CDATA[@deprecated call {@link #getUri()} instead.]]>
- </doc>
- </method>
- <method name="getNamed" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="call {@link #get(URI, Configuration)} instead.">
- <param name="name" type="java.lang.String"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated call {@link #get(URI, Configuration)} instead.]]>
- </doc>
- </method>
- <method name="getLocal" return="org.apache.hadoop.fs.LocalFileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the local FileSystem.
- @param conf the configuration to configure the FileSystem with
- if it is newly instantiated.
- @return a LocalFileSystem
- @throws IOException if somehow the local FS cannot be instantiated.]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a FileSystem for this URI's scheme and authority.
- <ol>
- <li>
- If the configuration has the property
- {@code "fs.$SCHEME.impl.disable.cache"} set to true,
- a new instance will be created, initialized with the supplied URI and
- configuration, then returned without being cached.
- </li>
- <li>
- If the there is a cached FS instance matching the same URI, it will
- be returned.
- </li>
- <li>
- Otherwise: a new FS instance will be created, initialized with the
- configuration and URI, cached and returned to the caller.
- </li>
- </ol>
- @throws IOException if the FileSystem cannot be instantiated.]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Returns the FileSystem for this URI's scheme and authority and the
- given user. Internally invokes {@link #newInstance(URI, Configuration)}
- @param uri of the filesystem
- @param conf the configuration to use
- @param user to perform the get as
- @return filesystem instance
- @throws IOException if the FileSystem cannot be instantiated.
- @throws InterruptedException If the {@code UGI.doAs()} call was
- somehow interrupted.]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="config" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the FileSystem for this URI's scheme and authority.
- The entire URI is passed to the FileSystem instance's initialize method.
- This always returns a new FileSystem object.
- @param uri FS URI
- @param config configuration to use
- @return the new FS instance
- @throws IOException FS creation or initialization failure.]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a unique configured FileSystem implementation for the default
- filesystem of the supplied configuration.
- This always returns a new FileSystem object.
- @param conf the configuration to use
- @return the new FS instance
- @throws IOException FS creation or initialization failure.]]>
- </doc>
- </method>
- <method name="newInstanceLocal" return="org.apache.hadoop.fs.LocalFileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a unique local FileSystem object.
- @param conf the configuration to configure the FileSystem with
- @return a new LocalFileSystem object.
- @throws IOException FS creation or initialization failure.]]>
- </doc>
- </method>
- <method name="closeAll"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close all cached FileSystem instances. After this operation, they
- may not be used in any operations.
- @throws IOException a problem arose closing one or more filesystem.]]>
- </doc>
- </method>
- <method name="closeAllForUGI"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close all cached FileSystem instances for a given UGI.
- Be sure those filesystems are not used anymore.
- @param ugi user group info to close
- @throws IOException a problem arose closing one or more filesystem.]]>
- </doc>
- </method>
- <method name="makeQualified" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Qualify a path to one which uses this FileSystem and, if relative,
- made absolute.
- @param path to qualify.
- @return this path if it contains a scheme and authority and is absolute, or
- a new path that includes a path and authority and is fully qualified
- @see Path#makeQualified(URI, Path)
- @throws IllegalArgumentException if the path has a schema/URI different
- from this FileSystem.]]>
- </doc>
- </method>
- <method name="addDelegationTokens" return="org.apache.hadoop.security.token.Token[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="java.lang.String"/>
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Obtain all delegation tokens used by this FileSystem that are not
- already present in the given Credentials. Existing tokens will neither
- be verified as valid nor having the given renewer. Missing tokens will
- be acquired and added to the given Credentials.
- Default Impl: works for simple FS with its own token
- and also for an embedded FS whose tokens are those of its
- child FileSystems (i.e. the embedded FS has no tokens of its own).
- @param renewer the user allowed to renew the delegation tokens
- @param credentials cache in which to add new delegation tokens
- @return list of new delegation tokens
- @throws IOException]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a file with the provided permission.
- The permission of the file is set to be the provided permission as in
- setPermission, not permission&~umask
- The HDFS implementation is implemented using two RPCs.
- It is understood that it is inefficient,
- but the implementation is thread-safe. The other option is to change the
- value of umask in configuration to be 0, but it is not thread-safe.
- @param fs FileSystem
- @param file the name of the file to be created
- @param permission the permission of the file
- @return an output stream
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a directory with the provided permission.
- The permission of the directory is set to be the provided permission as in
- setPermission, not permission&~umask
- @see #create(FileSystem, Path, FsPermission)
- @param fs FileSystem handle
- @param dir the name of the directory to be created
- @param permission the permission of the directory
- @return true if the directory creation succeeds; false otherwise
- @throws IOException A problem creating the directories.]]>
- </doc>
- </method>
- <method name="checkPath"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Check that a Path belongs to this FileSystem.
- The base implementation performs case insensitive equality checks
- of the URIs' schemes and authorities. Subclasses may implement slightly
- different checks.
- @param path to check
- @throws IllegalArgumentException if the path is not considered to be
- part of this FileSystem.]]>
- </doc>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="start" type="long"/>
- <param name="len" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return an array containing hostnames, offset and size of
- portions of the given file. For nonexistent
- file or regions, {@code null} is returned.
- <pre>
- if f == null :
- result = null
- elif f.getLen() <= start:
- result = []
- else result = [ locations(FS, b) for b in blocks(FS, p, s, s+l)]
- </pre>
- This call is most helpful with and distributed filesystem
- where the hostnames of machines that contain blocks of the given file
- can be determined.
- The default implementation returns an array containing one element:
- <pre>
- BlockLocation( { "localhost:50010" }, { "localhost" }, 0, file.getLen())
- </pre>>
- @param file FilesStatus to get data from
- @param start offset into the given file
- @param len length for which to get locations for
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="start" type="long"/>
- <param name="len" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return an array containing hostnames, offset and size of
- portions of the given file. For a nonexistent
- file or regions, {@code null} is returned.
- This call is most helpful with location-aware distributed
- filesystems, where it returns hostnames of machines that
- contain the given file.
- A FileSystem will normally return the equivalent result
- of passing the {@code FileStatus} of the path to
- {@link #getFileBlockLocations(FileStatus, long, long)}
- @param p path is used to identify an FS since an FS could have
- another FS that it could be delegating the call to
- @param start offset into the given file
- @param len length for which to get locations for
- @throws FileNotFoundException when the path does not exist
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getServerDefaults(Path)} instead">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a set of server default configuration values.
- @return server default configuration values
- @throws IOException IO failure
- @deprecated use {@link #getServerDefaults(Path)} instead]]>
- </doc>
- </method>
- <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a set of server default configuration values.
- @param p path is used to identify an FS since an FS could have
- another FS that it could be delegating the call to
- @return server default configuration values
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="resolvePath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the fully-qualified path of path, resolving the path
- through any symlinks or mount point.
- @param p path to be resolved
- @return fully qualified path
- @throws FileNotFoundException if the path is not present
- @throws IOException for any other error]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataInputStream at the indicated Path.
- @param f the file name to open
- @param bufferSize the size of the buffer to be used.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataInputStream at the indicated Path.
- @param f the file to open
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path.
- Files are overwritten by default.
- @param f the file to create
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path.
- @param f the file to create
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an exception will be thrown.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
- reporting.
- Files are overwritten by default.
- @param f the file to create
- @param progress to report progress
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path.
- Files are overwritten by default.
- @param f the file to create
- @param replication the replication factor
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
- reporting.
- Files are overwritten by default.
- @param f the file to create
- @param replication the replication factor
- @param progress to report progress
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path.
- @param f the file to create
- @param overwrite if a path with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an {@link FSDataOutputStream} at the indicated Path
- with write-progress reporting.
- The frequency of callbacks is implementation-specific; it may be "none".
- @param f the path of the file to open
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path.
- @param f the file name to open
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
- reporting.
- @param f the file name to open
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
- reporting.
- @param f the file name to open
- @param permission file permission
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @param blockSize block size
- @param progress the progress reporter
- @throws IOException IO failure
- @see #setPermission(Path, FsPermission)]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="flags" type="java.util.EnumSet"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
- reporting.
- @param f the file name to open
- @param permission file permission
- @param flags {@link CreateFlag}s to use for this stream.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @param blockSize block size
- @param progress the progress reporter
- @throws IOException IO failure
- @see #setPermission(Path, FsPermission)]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="flags" type="java.util.EnumSet"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path with a custom
- checksum option.
- @param f the file name to open
- @param permission file permission
- @param flags {@link CreateFlag}s to use for this stream.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @param blockSize block size
- @param progress the progress reporter
- @param checksumOpt checksum parameter. If null, the values
- found in conf will be used.
- @throws IOException IO failure
- @see #setPermission(Path, FsPermission)]]>
- </doc>
- </method>
- <method name="primitiveCreate" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="flag" type="java.util.EnumSet"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This create has been added to support the FileContext that processes
- the permission with umask before calling this method.
- This a temporary method added to support the transition from FileSystem
- to FileContext for user applications.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="primitiveMkdir" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This version of the mkdirs method assumes that the permission is absolute.
- It has been added to support the FileContext that processes the permission
- with umask before calling this method.
- This a temporary method added to support the transition from FileSystem
- to FileContext for user applications.
- @param f path
- @param absolutePermission permissions
- @return true if the directory was actually created.
- @throws IOException IO failure
- @see #mkdirs(Path, FsPermission)]]>
- </doc>
- </method>
- <method name="primitiveMkdir"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="createParent" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This version of the mkdirs method assumes that the permission is absolute.
- It has been added to support the FileContext that processes the permission
- with umask before calling this method.
- This a temporary method added to support the transition from FileSystem
- to FileContext for user applications.]]>
- </doc>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
- reporting. Same as create(), except fails if parent directory doesn't
- already exist.
- @param f the file name to open
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @param blockSize block size
- @param progress the progress reporter
- @throws IOException IO failure
- @see #setPermission(Path, FsPermission)]]>
- </doc>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
- reporting. Same as create(), except fails if parent directory doesn't
- already exist.
- @param f the file name to open
- @param permission file permission
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @param blockSize block size
- @param progress the progress reporter
- @throws IOException IO failure
- @see #setPermission(Path, FsPermission)]]>
- </doc>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="flags" type="java.util.EnumSet"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
- reporting. Same as create(), except fails if parent directory doesn't
- already exist.
- @param f the file name to open
- @param permission file permission
- @param flags {@link CreateFlag}s to use for this stream.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @param blockSize block size
- @param progress the progress reporter
- @throws IOException IO failure
- @see #setPermission(Path, FsPermission)]]>
- </doc>
- </method>
- <method name="createNewFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates the given Path as a brand-new zero-length file. If
- create fails, or if it already existed, return false.
- <i>Important: the default implementation is not atomic</i>
- @param f path to use for create
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append to an existing file (optional operation).
- Same as
- {@code append(f, getConf().getInt(IO_FILE_BUFFER_SIZE_KEY,
- IO_FILE_BUFFER_SIZE_DEFAULT), null)}
- @param f the existing file to be appended.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default).]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append to an existing file (optional operation).
- Same as append(f, bufferSize, null).
- @param f the existing file to be appended.
- @param bufferSize the size of the buffer to be used.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default).]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append to an existing file (optional operation).
- @param f the existing file to be appended.
- @param bufferSize the size of the buffer to be used.
- @param progress for reporting progress if it is not null.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default).]]>
- </doc>
- </method>
- <method name="concat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="trg" type="org.apache.hadoop.fs.Path"/>
- <param name="psrcs" type="org.apache.hadoop.fs.Path[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Concat existing files together.
- @param trg the path to the target destination.
- @param psrcs the paths to the sources to use for the concatenation.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default).]]>
- </doc>
- </method>
- <method name="getReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #getFileStatus(Path)} instead">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the replication factor.
- @deprecated Use {@link #getFileStatus(Path)} instead
- @param src file name
- @return file replication
- @throws FileNotFoundException if the path does not resolve.
- @throws IOException an IO failure]]>
- </doc>
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the replication for an existing file.
- If a filesystem does not support replication, it will always
- return true: the check for a file existing may be bypassed.
- This is the default behavior.
- @param src file name
- @param replication new replication
- @throws IOException
- @return true if successful, or the feature in unsupported;
- false if replication is supported but the file does not exist,
- or is a directory]]>
- </doc>
- </method>
- <method name="rename" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Renames Path src to Path dst.
- @param src path to be renamed
- @param dst new path after rename
- @throws IOException on failure
- @return true if rename is successful]]>
- </doc>
- </method>
- <method name="rename"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="options" type="org.apache.hadoop.fs.Options.Rename[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Renames Path src to Path dst
- <ul>
- <li>Fails if src is a file and dst is a directory.</li>
- <li>Fails if src is a directory and dst is a file.</li>
- <li>Fails if the parent of dst does not exist or is a file.</li>
- </ul>
- <p>
- If OVERWRITE option is not passed as an argument, rename fails
- if the dst already exists.
- <p>
- If OVERWRITE option is passed as an argument, rename overwrites
- the dst if it is a file or an empty directory. Rename fails if dst is
- a non-empty directory.
- <p>
- Note that atomicity of rename is dependent on the file system
- implementation. Please refer to the file system documentation for
- details. This default implementation is non atomic.
- <p>
- This method is deprecated since it is a temporary method added to
- support the transition from FileSystem to FileContext for user
- applications.
- @param src path to be renamed
- @param dst new path after rename
- @throws FileNotFoundException src path does not exist, or the parent
- path of dst does not exist.
- @throws FileAlreadyExistsException dest path exists and is a file
- @throws ParentNotDirectoryException if the parent path of dest is not
- a directory
- @throws IOException on failure]]>
- </doc>
- </method>
- <method name="truncate" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="newLength" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Truncate the file in the indicated path to the indicated size.
- <ul>
- <li>Fails if path is a directory.</li>
- <li>Fails if path does not exist.</li>
- <li>Fails if path is not closed.</li>
- <li>Fails if new size is greater than current size.</li>
- </ul>
- @param f The path to the file to be truncated
- @param newLength The size the file is to be truncated to
- @return <code>true</code> if the file has been truncated to the desired
- <code>newLength</code> and is immediately available to be reused for
- write operations such as <code>append</code>, or
- <code>false</code> if a background process of adjusting the length of
- the last block has been started, and clients should wait for it to
- complete before proceeding with further file updates.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default).]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #delete(Path, boolean)} instead.">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete a file/directory.
- @deprecated Use {@link #delete(Path, boolean)} instead.]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete a file.
- @param f the path to delete.
- @param recursive if path is a directory and set to
- true, the directory is deleted else throws an exception. In
- case of a file the recursive can be set to either true or false.
- @return true if delete is successful else false.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="deleteOnExit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark a path to be deleted when its FileSystem is closed.
- When the JVM shuts down cleanly, all cached FileSystem objects will be
- closed automatically #these the marked paths will be deleted as a result.
- If a FileSystem instance is not cached, i.e. has been created with
- {@link #createFileSystem(URI, Configuration)}, then the paths will
- be deleted in when {@link #close()} is called on that instance.
- The path must exist in the filesystem at the time of the method call;
- it does not have to exist at the time of JVM shutdown.
- Notes
- <ol>
- <li>Clean shutdown of the JVM cannot be guaranteed.</li>
- <li>The time to shut down a FileSystem will depends on the number of
- files to delete. For filesystems where the cost of checking
- for the existence of a file/directory and the actual delete operation
- (for example: object stores) is high, the time to shutdown the JVM can be
- significantly extended by over-use of this feature.</li>
- <li>Connectivity problems with a remote filesystem may delay shutdown
- further, and may cause the files to not be deleted.</li>
- </ol>
- @param f the path to delete.
- @return true if deleteOnExit is successful, otherwise false.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="cancelDeleteOnExit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Cancel the scheduled deletion of the path when the FileSystem is closed.
- @param f the path to cancel deletion
- @return true if the path was found in the delete-on-exit list.]]>
- </doc>
- </method>
- <method name="processDeleteOnExit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Delete all paths that were marked as delete-on-exit. This recursively
- deletes all files and directories in the specified paths.
- The time to process this operation is {@code O(paths)}, with the actual
- time dependent on the time for existence and deletion operations to
- complete, successfully or not.]]>
- </doc>
- </method>
- <method name="exists" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check if a path exists.
- @param f source path
- @return true if the path exists
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="isDirectory" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[True iff the named path is a directory.
- Note: Avoid using this method. Instead reuse the FileStatus
- returned by getFileStatus() or listStatus() methods.
- @param f path to check
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="isFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[True iff the named path is a regular file.
- Note: Avoid using this method. Instead reuse the FileStatus
- returned by {@link #getFileStatus(Path)} or listStatus() methods.
- @param f path to check
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #getFileStatus(Path)} instead.">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The number of bytes in a file.
- @return the number of bytes; 0 for a directory
- @deprecated Use {@link #getFileStatus(Path)} instead.
- @throws FileNotFoundException if the path does not resolve
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="getContentSummary" return="org.apache.hadoop.fs.ContentSummary"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the {@link ContentSummary} of a given {@link Path}.
- @param f path to use
- @throws FileNotFoundException if the path does not resolve
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="getQuotaUsage" return="org.apache.hadoop.fs.QuotaUsage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the {@link QuotaUsage} of a given {@link Path}.
- @param f path to use
- @return the quota usage
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List the statuses of the files/directories in the given path if the path is
- a directory.
- <p>
- Does not guarantee to return the List of files/directories status in a
- sorted order.
- @param f given path
- @return the statuses of the files/directories in the given patch
- @throws FileNotFoundException when the path does not exist
- @throws IOException see specific implementation]]>
- </doc>
- </method>
- <method name="listCorruptFileBlocks" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List corrupted file blocks.
- @return an iterator over the corrupt files under the given path
- (may contain duplicates if a file has more than one corrupt block)
- @throws UnsupportedOperationException if the operation is unsupported
- (default).
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Filter files/directories in the given path using the user-supplied path
- filter.
- <p>
- Does not guarantee to return the List of files/directories status in a
- sorted order.
- @param f
- a path name
- @param filter
- the user-supplied path filter
- @return an array of FileStatus objects for the files under the given path
- after applying the filter
- @throws FileNotFoundException when the path does not exist
- @throws IOException see specific implementation]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="files" type="org.apache.hadoop.fs.Path[]"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Filter files/directories in the given list of paths using default
- path filter.
- <p>
- Does not guarantee to return the List of files/directories status in a
- sorted order.
- @param files
- a list of paths
- @return a list of statuses for the files under the given paths after
- applying the filter default Path filter
- @throws FileNotFoundException when the path does not exist
- @throws IOException see specific implementation]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="files" type="org.apache.hadoop.fs.Path[]"/>
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Filter files/directories in the given list of paths using user-supplied
- path filter.
- <p>
- Does not guarantee to return the List of files/directories status in a
- sorted order.
- @param files
- a list of paths
- @param filter
- the user-supplied path filter
- @return a list of statuses for the files under the given paths after
- applying the filter
- @throws FileNotFoundException when the path does not exist
- @throws IOException see specific implementation]]>
- </doc>
- </method>
- <method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathPattern" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>Return all the files that match filePattern and are not checksum
- files. Results are sorted by their names.
- <p>
- A filename pattern is composed of <i>regular</i> characters and
- <i>special pattern matching</i> characters, which are:
- <dl>
- <dd>
- <dl>
- <p>
- <dt> <tt> ? </tt>
- <dd> Matches any single character.
- <p>
- <dt> <tt> * </tt>
- <dd> Matches zero or more characters.
- <p>
- <dt> <tt> [<i>abc</i>] </tt>
- <dd> Matches a single character from character set
- <tt>{<i>a,b,c</i>}</tt>.
- <p>
- <dt> <tt> [<i>a</i>-<i>b</i>] </tt>
- <dd> Matches a single character from the character range
- <tt>{<i>a...b</i>}</tt>. Note that character <tt><i>a</i></tt> must be
- lexicographically less than or equal to character <tt><i>b</i></tt>.
- <p>
- <dt> <tt> [^<i>a</i>] </tt>
- <dd> Matches a single character that is not from character set or range
- <tt>{<i>a</i>}</tt>. Note that the <tt>^</tt> character must occur
- immediately to the right of the opening bracket.
- <p>
- <dt> <tt> \<i>c</i> </tt>
- <dd> Removes (escapes) any special meaning of character <i>c</i>.
- <p>
- <dt> <tt> {ab,cd} </tt>
- <dd> Matches a string from the string set <tt>{<i>ab, cd</i>} </tt>
- <p>
- <dt> <tt> {ab,c{de,fh}} </tt>
- <dd> Matches a string from the string set <tt>{<i>ab, cde, cfh</i>}</tt>
- </dl>
- </dd>
- </dl>
- @param pathPattern a regular expression specifying a pth pattern
- @return an array of paths that match the path pattern
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathPattern" type="org.apache.hadoop.fs.Path"/>
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return an array of {@link FileStatus} objects whose path names match
- {@code pathPattern}
- and is accepted by the user-supplied path filter. Results are sorted by
- their path names.
- Return
- @param pathPattern
- a regular expression specifying the path pattern
- @param filter
- a user-supplied path filter
- @return an array of FileStatus objects.
- null if pathPattern has no glob and the path does not exist.
- an empty array if pathPattern has a glob and no path matches it.
- @throws IOException if any I/O error occurs when fetching file status]]>
- </doc>
- </method>
- <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List the statuses of the files/directories in the given path if the path is
- a directory.
- Return the file's status and block locations If the path is a file.
- If a returned status is a file, it contains the file's block locations.
- @param f is the path
- @return an iterator that traverses statuses of the files/directories
- in the given path
- @throws FileNotFoundException If <code>f</code> does not exist
- @throws IOException If an I/O error occurred]]>
- </doc>
- </method>
- <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List a directory.
- The returned results include its block location if it is a file
- The results are filtered by the given path filter
- @param f a path
- @param filter a path filter
- @return an iterator that traverses statuses of the files/directories
- in the given path
- @throws FileNotFoundException if <code>f</code> does not exist
- @throws IOException if any I/O error occurred]]>
- </doc>
- </method>
- <method name="listStatusIterator" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a remote iterator so that followup calls are made on demand
- while consuming the entries. Each FileSystem implementation should
- override this method and provide a more efficient implementation, if
- possible.
- Does not guarantee to return the iterator that traverses statuses
- of the files in a sorted order.
- @param p target path
- @return remote iterator
- @throws FileNotFoundException if <code>p</code> does not exist
- @throws IOException if any I/O error occurred]]>
- </doc>
- </method>
- <method name="listFiles" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List the statuses and block locations of the files in the given path.
- Does not guarantee to return the iterator that traverses statuses
- of the files in a sorted order.
- <pre>
- If the path is a directory,
- if recursive is false, returns files in the directory;
- if recursive is true, return files in the subtree rooted at the path.
- If the path is a file, return the file's status and block locations.
- </pre>
- @param f is the path
- @param recursive if the subdirectories need to be traversed recursively
- @return an iterator that traverses statuses of the files
- @throws FileNotFoundException when the path does not exist;
- @throws IOException see specific implementation]]>
- </doc>
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the current user's home directory in this FileSystem.
- The default implementation returns {@code "/user/$USER/"}.]]>
- </doc>
- </method>
- <method name="setWorkingDirectory"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="new_dir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the current working directory for the given FileSystem. All relative
- paths will be resolved relative to it.
- @param new_dir Path of new working directory]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current working directory for the given FileSystem
- @return the directory pathname]]>
- </doc>
- </method>
- <method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Note: with the new FileContext class, getWorkingDirectory()
- will be removed.
- The working directory is implemented in FileContext.
- Some FileSystems like LocalFileSystem have an initial workingDir
- that we use as the starting workingDir. For other file systems
- like HDFS there is no built in notion of an initial workingDir.
- @return if there is built in notion of workingDir then it
- is returned; else a null is returned.]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Call {@link #mkdirs(Path, FsPermission)} with default permission.
- @param f path
- @return true if the directory was created
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make the given file and all non-existent parents into
- directories. Has roughly the semantics of Unix @{code mkdir -p}.
- Existence of the directory hierarchy is not an error.
- @param f path to create
- @param permission to apply to f
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to filesystem at
- the given dst name and the source is kept intact afterwards
- @param src path
- @param dst path
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="moveFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src files is on the local disk. Add it to filesystem at
- the given dst name, removing the source afterwards.
- @param srcs source paths
- @param dst path
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="moveFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to the filesystem at
- the given dst name, removing the source afterwards.
- @param src local path
- @param dst path
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to the filesystem at
- the given dst name.
- delSrc indicates if the source should be removed
- @param delSrc whether to delete the src
- @param src path
- @param dst path]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src files are on the local disk. Add it to the filesystem at
- the given dst name.
- delSrc indicates if the source should be removed
- @param delSrc whether to delete the src
- @param overwrite whether to overwrite an existing file
- @param srcs array of paths which are source
- @param dst path
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to the filesystem at
- the given dst name.
- delSrc indicates if the source should be removed
- @param delSrc whether to delete the src
- @param overwrite whether to overwrite an existing file
- @param src path
- @param dst path
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy it a file from the remote filesystem to the local one.
- @param src path src file in the remote filesystem
- @param dst path local destination
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="moveToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy a file to the local filesystem, then delete it from the
- remote filesystem (if successfully copied).
- @param src path src file in the remote filesystem
- @param dst path local destination
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy it a file from a remote filesystem to the local one.
- delSrc indicates if the src will be removed or not.
- @param delSrc whether to delete the src
- @param src path src file in the remote filesystem
- @param dst path local destination
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="useRawLocalFileSystem" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is under this filesystem, and the dst is on the local disk.
- Copy it from the remote filesystem to the local dst name.
- delSrc indicates if the src will be removed
- or not. useRawLocalFileSystem indicates whether to use RawLocalFileSystem
- as the local file system or not. RawLocalFileSystem is non checksumming,
- So, It will not create any crc files at local.
- @param delSrc
- whether to delete the src
- @param src
- path
- @param dst
- path
- @param useRawLocalFileSystem
- whether to use RawLocalFileSystem as local file system or not.
- @throws IOException for any IO error]]>
- </doc>
- </method>
- <method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a local file that the user can write output to. The caller
- provides both the eventual target name in this FileSystem
- and the local working file path.
- If this FileSystem is local, we write directly into the target. If
- the FileSystem is not local, we write into the tmp local area.
- @param fsOutputFile path of output file
- @param tmpLocalFile path of local tmp file
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="completeLocalOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called when we're all done writing to the target.
- A local FS will do nothing, because we've written to exactly the
- right place.
- A remote FS will copy the contents of tmpLocalFile to the correct target at
- fsOutputFile.
- @param fsOutputFile path of output file
- @param tmpLocalFile path to local tmp file
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close this FileSystem instance.
- Will release any held locks, delete all files queued for deletion
- through calls to {@link #deleteOnExit(Path)}, and remove this FS instance
- from the cache, if cached.
- After this operation, the outcome of any method call on this FileSystem
- instance, or any input/output stream created by it is <i>undefined</i>.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="getUsed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the total size of all files in the filesystem.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="getUsed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the total size of all files from a specified path.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="getBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #getFileStatus(Path)} instead">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the block size for a particular file.
- @param f the filename
- @return the number of bytes in a block
- @deprecated Use {@link #getFileStatus(Path)} instead
- @throws FileNotFoundException if the path is not present
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="getDefaultBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getDefaultBlockSize(Path)} instead">
- <doc>
- <![CDATA[Return the number of bytes that large input files should be optimally
- be split into to minimize I/O time.
- @deprecated use {@link #getDefaultBlockSize(Path)} instead]]>
- </doc>
- </method>
- <method name="getDefaultBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Return the number of bytes that large input files should be optimally
- be split into to minimize I/O time. The given path will be used to
- locate the actual filesystem. The full path does not have to exist.
- @param f path of file
- @return the default block size for the path's filesystem]]>
- </doc>
- </method>
- <method name="getDefaultReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getDefaultReplication(Path)} instead">
- <doc>
- <![CDATA[Get the default replication.
- @return the replication; the default value is "1".
- @deprecated use {@link #getDefaultReplication(Path)} instead]]>
- </doc>
- </method>
- <method name="getDefaultReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Get the default replication for a path.
- The given path will be used to locate the actual FileSystem to query.
- The full path does not have to exist.
- @param path of the file
- @return default replication for the path's filesystem]]>
- </doc>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a file status object that represents the path.
- @param f The path we want information from
- @return a FileStatus object
- @throws FileNotFoundException when the path does not exist
- @throws IOException see specific implementation]]>
- </doc>
- </method>
- <method name="fixRelativePart" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[See {@link FileContext#fixRelativePart}.]]>
- </doc>
- </method>
- <method name="createSymlink"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="org.apache.hadoop.fs.Path"/>
- <param name="link" type="org.apache.hadoop.fs.Path"/>
- <param name="createParent" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[See {@link FileContext#createSymlink(Path, Path, boolean)}.]]>
- </doc>
- </method>
- <method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[See {@link FileContext#getFileLinkStatus(Path)}.
- @throws FileNotFoundException when the path does not exist
- @throws IOException see specific implementation]]>
- </doc>
- </method>
- <method name="supportsSymlinks" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See {@link AbstractFileSystem#supportsSymlinks()}.]]>
- </doc>
- </method>
- <method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[See {@link FileContext#getLinkTarget(Path)}.
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="resolveLink" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[See {@link AbstractFileSystem#getLinkTarget(Path)}.
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the checksum of a file, if the FS supports checksums.
- @param f The file path
- @return The file checksum. The default return value is null,
- which indicates that no checksum algorithm is implemented
- in the corresponding FileSystem.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="length" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the checksum of a file, from the beginning of the file till the
- specific length.
- @param f The file path
- @param length The length of the file range for checksum calculation
- @return The file checksum or null if checksums are not supported.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="setVerifyChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- <doc>
- <![CDATA[Set the verify checksum flag. This is only applicable if the
- corresponding filesystem supports checksums. By default doesn't do anything.
- @param verifyChecksum Verify checksum flag]]>
- </doc>
- </method>
- <method name="setWriteChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writeChecksum" type="boolean"/>
- <doc>
- <![CDATA[Set the write checksum flag. This is only applicable if the
- corresponding filesystem supports checksums. By default doesn't do anything.
- @param writeChecksum Write checksum flag]]>
- </doc>
- </method>
- <method name="getStatus" return="org.apache.hadoop.fs.FsStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a status object describing the use and capacity of the
- filesystem. If the filesystem has multiple partitions, the
- use and capacity of the root partition is reflected.
- @return a FsStatus object
- @throws IOException
- see specific implementation]]>
- </doc>
- </method>
- <method name="getStatus" return="org.apache.hadoop.fs.FsStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a status object describing the use and capacity of the
- filesystem. If the filesystem has multiple partitions, the
- use and capacity of the partition pointed to by the specified
- path is reflected.
- @param p Path for which status should be obtained. null means
- the default partition.
- @return a FsStatus object
- @throws IOException
- see specific implementation]]>
- </doc>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set permission of a path.
- @param p The path
- @param permission permission
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set owner of a path (i.e. a file or a directory).
- The parameters username and groupname cannot both be null.
- @param p The path
- @param username If it is null, the original username remains unchanged.
- @param groupname If it is null, the original groupname remains unchanged.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="setTimes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="mtime" type="long"/>
- <param name="atime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set access time of a file.
- @param p The path
- @param mtime Set the modification time of this file.
- The number of milliseconds since Jan 1, 1970.
- A value of -1 means that this call should not set modification time.
- @param atime Set the access time of this file.
- The number of milliseconds since Jan 1, 1970.
- A value of -1 means that this call should not set access time.
- @throws IOException IO failure]]>
- </doc>
- </method>
- <method name="createSnapshot" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a snapshot with a default name.
- @param path The directory where snapshots will be taken.
- @return the snapshot path.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported]]>
- </doc>
- </method>
- <method name="createSnapshot" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a snapshot.
- @param path The directory where snapshots will be taken.
- @param snapshotName The name of the snapshot
- @return the snapshot path.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported]]>
- </doc>
- </method>
- <method name="renameSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotOldName" type="java.lang.String"/>
- <param name="snapshotNewName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Rename a snapshot.
- @param path The directory path where the snapshot was taken
- @param snapshotOldName Old name of the snapshot
- @param snapshotNewName New name of the snapshot
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="deleteSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete a snapshot of a directory.
- @param path The directory that the to-be-deleted snapshot belongs to
- @param snapshotName The name of the snapshot
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="modifyAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Modifies ACL entries of files and directories. This method can add new ACL
- entries or modify the permissions on existing ACL entries. All existing
- ACL entries that are not specified in this call are retained without
- changes. (Modifications are merged into the current ACL.)
- @param path Path to modify
- @param aclSpec List<AclEntry> describing modifications
- @throws IOException if an ACL could not be modified
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="removeAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Removes ACL entries from files and directories. Other ACL entries are
- retained.
- @param path Path to modify
- @param aclSpec List describing entries to remove
- @throws IOException if an ACL could not be modified
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="removeDefaultAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Removes all default ACL entries from files and directories.
- @param path Path to modify
- @throws IOException if an ACL could not be modified
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="removeAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Removes all but the base ACL entries of files and directories. The entries
- for user, group, and others are retained for compatibility with permission
- bits.
- @param path Path to modify
- @throws IOException if an ACL could not be removed
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="setAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fully replaces ACL of files and directories, discarding all existing
- entries.
- @param path Path to modify
- @param aclSpec List describing modifications, which must include entries
- for user, group, and others for compatibility with permission bits.
- @throws IOException if an ACL could not be modified
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="getAclStatus" return="org.apache.hadoop.fs.permission.AclStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the ACL of a file or directory.
- @param path Path to get
- @return AclStatus describing the ACL of the file or directory
- @throws IOException if an ACL could not be read
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="setXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set an xattr of a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to modify
- @param name xattr name.
- @param value xattr value.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="setXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="byte[]"/>
- <param name="flag" type="java.util.EnumSet"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set an xattr of a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to modify
- @param name xattr name.
- @param value xattr value.
- @param flag xattr set flag
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="getXAttr" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get an xattr name and value for a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attribute
- @param name xattr name.
- @return byte[] xattr value.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all of the xattr name/value pairs for a file or directory.
- Only those xattrs which the logged-in user has permissions to view
- are returned.
- <p>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attributes
- @return Map describing the XAttrs of the file or directory
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="names" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all of the xattrs name/value pairs for a file or directory.
- Only those xattrs which the logged-in user has permissions to view
- are returned.
- <p>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attributes
- @param names XAttr names.
- @return Map describing the XAttrs of the file or directory
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="listXAttrs" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all of the xattr names for a file or directory.
- Only those xattr names which the logged-in user has permissions to view
- are returned.
- <p>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to get extended attributes
- @return List<String> of the XAttr names of the file or directory
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="removeXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Remove an xattr of a file or directory.
- The name must be prefixed with the namespace followed by ".". For example,
- "user.attr".
- <p>
- Refer to the HDFS extended attributes user documentation for details.
- @param path Path to remove extended attribute
- @param name xattr name
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="setStoragePolicy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="policyName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the storage policy for a given file or directory.
- @param src file or directory path.
- @param policyName the name of the target storage policy. The list
- of supported Storage policies can be retrieved
- via {@link #getAllStoragePolicies}.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="unsetStoragePolicy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Unset the storage policy set for a given file or directory.
- @param src file or directory path.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="getStoragePolicy" return="org.apache.hadoop.fs.BlockStoragePolicySpi"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Query the effective storage policy ID for the given file or directory.
- @param src file or directory path.
- @return storage policy for give file.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="getAllStoragePolicies" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Retrieve all the storage policies supported by this file system.
- @return all storage policies supported by this filesystem.
- @throws IOException IO failure
- @throws UnsupportedOperationException if the operation is unsupported
- (default outcome).]]>
- </doc>
- </method>
- <method name="getTrashRoot" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Get the root directory of Trash for current user when the path specified
- is deleted.
- @param path the trash root of the path to be determined.
- @return the default implementation returns {@code /user/$USER/.Trash}]]>
- </doc>
- </method>
- <method name="getTrashRoots" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allUsers" type="boolean"/>
- <doc>
- <![CDATA[Get all the trash roots for current user or all users.
- @param allUsers return trash roots for all users if true.
- @return all the trash root directories.
- Default FileSystem returns .Trash under users' home directories if
- {@code /user/$USER/.Trash} exists.]]>
- </doc>
- </method>
- <method name="getFileSystemClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scheme" type="java.lang.String"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the FileSystem implementation class of a filesystem.
- This triggers a scan and load of all FileSystem implementations listed as
- services and discovered via the {@link ServiceLoader}
- @param scheme URL scheme of FS
- @param conf configuration: can be null, in which case the check for
- a filesystem binding declaration in the configuration is skipped.
- @return the filesystem
- @throws UnsupportedFileSystemException if there was no known implementation
- for the scheme.
- @throws IOException if the filesystem could not be loaded]]>
- </doc>
- </method>
- <method name="getStatistics" return="java.util.Map"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="use {@link #getGlobalStorageStatistics()}">
- <doc>
- <![CDATA[Get the Map of Statistics object indexed by URI Scheme.
- @return a Map having a key as URI scheme and value as Statistics object
- @deprecated use {@link #getGlobalStorageStatistics()}]]>
- </doc>
- </method>
- <method name="getAllStatistics" return="java.util.List"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="use {@link #getGlobalStorageStatistics()}">
- <doc>
- <![CDATA[Return the FileSystem classes that have Statistics.
- @deprecated use {@link #getGlobalStorageStatistics()}]]>
- </doc>
- </method>
- <method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="use {@link #getGlobalStorageStatistics()}">
- <param name="scheme" type="java.lang.String"/>
- <param name="cls" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the statistics for a particular file system.
- @param cls the class to lookup
- @return a statistics object
- @deprecated use {@link #getGlobalStorageStatistics()}]]>
- </doc>
- </method>
- <method name="clearStatistics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reset all statistics for all file systems.]]>
- </doc>
- </method>
- <method name="printStatistics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Print all statistics for all file systems to {@code System.out}]]>
- </doc>
- </method>
- <method name="areSymlinksEnabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="enableSymlinks"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStorageStatistics" return="org.apache.hadoop.fs.StorageStatistics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the StorageStatistics for this FileSystem object. These statistics are
- per-instance. They are not shared with any other FileSystem object.
- <p>This is a default method which is intended to be overridden by
- subclasses. The default implementation returns an empty storage statistics
- object.</p>
- @return The StorageStatistics for this FileSystem instance.
- Will never be null.]]>
- </doc>
- </method>
- <method name="getGlobalStorageStatistics" return="org.apache.hadoop.fs.GlobalStorageStatistics"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the global storage statistics.]]>
- </doc>
- </method>
- <method name="createFile" return="org.apache.hadoop.fs.FSDataOutputStreamBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Create a new FSDataOutputStreamBuilder for the file with path.
- Files are overwritten by default.
- @param path file path
- @return a FSDataOutputStreamBuilder object to build the file
- HADOOP-14384. Temporarily reduce the visibility of method before the
- builder interface becomes stable.]]>
- </doc>
- </method>
- <method name="appendFile" return="org.apache.hadoop.fs.FSDataOutputStreamBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Create a Builder to append a file.
- @param path file path.
- @return a {@link FSDataOutputStreamBuilder} to build file append request.]]>
- </doc>
- </method>
- <field name="FS_DEFAULT_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This log is widely used in the org.apache.hadoop.fs code and tests,
- so must be considered something to only be changed with care.]]>
- </doc>
- </field>
- <field name="SHUTDOWN_HOOK_PRIORITY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Priority of the FileSystem shutdown hook: {@value}.]]>
- </doc>
- </field>
- <field name="TRASH_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prefix for trash directory: {@value}.]]>
- </doc>
- </field>
- <field name="USER_HOME_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="statistics" type="org.apache.hadoop.fs.FileSystem.Statistics"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The statistics for this file system.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[An abstract base class for a fairly generic filesystem. It
- may be implemented as a distributed filesystem, or as a "local"
- one that reflects the locally-connected disk. The local version
- exists for small Hadoop instances and for testing.
- <p>
- All user code that may potentially use the Hadoop Distributed
- File System should be written to use a FileSystem object or its
- successor, {@link FileContext}.
- <p>
- The local implementation is {@link LocalFileSystem} and distributed
- implementation is DistributedFileSystem. There are other implementations
- for object stores and (outside the Apache Hadoop codebase),
- third party filesystems.
- <p>
- Notes
- <ol>
- <li>The behaviour of the filesystem is
- <a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/filesystem/filesystem.html">
- specified in the Hadoop documentation. </a>
- However, the normative specification of the behavior of this class is
- actually HDFS: if HDFS does not behave the way these Javadocs or
- the specification in the Hadoop documentations define, assume that
- the documentation is incorrect.
- </li>
- <li>The term {@code FileSystem} refers to an instance of this class.</li>
- <li>The acronym "FS" is used as an abbreviation of FileSystem.</li>
- <li>The term {@code filesystem} refers to the distributed/local filesystem
- itself, rather than the class used to interact with it.</li>
- <li>The term "file" refers to a file in the remote filesystem,
- rather than instances of {@code java.io.File}.</li>
- </ol>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileSystem -->
- <!-- start class org.apache.hadoop.fs.FileUtil -->
- <class name="FileUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileUtil"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="stat2Paths" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stats" type="org.apache.hadoop.fs.FileStatus[]"/>
- <doc>
- <![CDATA[convert an array of FileStatus to an array of Path
-
- @param stats
- an array of FileStatus objects
- @return an array of paths corresponding to the input]]>
- </doc>
- </method>
- <method name="stat2Paths" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stats" type="org.apache.hadoop.fs.FileStatus[]"/>
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[convert an array of FileStatus to an array of Path.
- If stats if null, return path
- @param stats
- an array of FileStatus objects
- @param path
- default path to return in stats is null
- @return an array of paths corresponding to the input]]>
- </doc>
- </method>
- <method name="fullyDeleteOnExit"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.io.File"/>
- <doc>
- <![CDATA[Register all files recursively to be deleted on exit.
- @param file File/directory to be deleted]]>
- </doc>
- </method>
- <method name="fullyDelete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <doc>
- <![CDATA[Delete a directory and all its contents. If
- we return false, the directory may be partially-deleted.
- (1) If dir is symlink to a file, the symlink is deleted. The file pointed
- to by the symlink is not deleted.
- (2) If dir is symlink to a directory, symlink is deleted. The directory
- pointed to by symlink is not deleted.
- (3) If dir is a normal file, it is deleted.
- (4) If dir is a normal directory, then dir and all its contents recursively
- are deleted.]]>
- </doc>
- </method>
- <method name="fullyDelete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <param name="tryGrantPermissions" type="boolean"/>
- <doc>
- <![CDATA[Delete a directory and all its contents. If
- we return false, the directory may be partially-deleted.
- (1) If dir is symlink to a file, the symlink is deleted. The file pointed
- to by the symlink is not deleted.
- (2) If dir is symlink to a directory, symlink is deleted. The directory
- pointed to by symlink is not deleted.
- (3) If dir is a normal file, it is deleted.
- (4) If dir is a normal directory, then dir and all its contents recursively
- are deleted.
- @param dir the file or directory to be deleted
- @param tryGrantPermissions true if permissions should be modified to delete a file.
- @return true on success false on failure.]]>
- </doc>
- </method>
- <method name="readLink" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <doc>
- <![CDATA[Returns the target of the given symlink. Returns the empty string if
- the given path does not refer to a symlink or there is an error
- accessing the symlink.
- @param f File representing the symbolic link.
- @return The target of the symbolic link, empty string on error or if not
- a symlink.]]>
- </doc>
- </method>
- <method name="fullyDeleteContents" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <doc>
- <![CDATA[Delete the contents of a directory, not the directory itself. If
- we return false, the directory may be partially-deleted.
- If dir is a symlink to a directory, all the contents of the actual
- directory pointed to by dir will be deleted.]]>
- </doc>
- </method>
- <method name="fullyDeleteContents" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <param name="tryGrantPermissions" type="boolean"/>
- <doc>
- <![CDATA[Delete the contents of a directory, not the directory itself. If
- we return false, the directory may be partially-deleted.
- If dir is a symlink to a directory, all the contents of the actual
- directory pointed to by dir will be deleted.
- @param tryGrantPermissions if 'true', try grant +rwx permissions to this
- and all the underlying directories before trying to delete their contents.]]>
- </doc>
- </method>
- <method name="fullyDelete"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link FileSystem#delete(Path, boolean)}">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Recursively delete a directory.
-
- @param fs {@link FileSystem} on which the path is present
- @param dir directory to recursively delete
- @throws IOException
- @deprecated Use {@link FileSystem#delete(Path, boolean)}]]>
- </doc>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy files between FileSystems.]]>
- </doc>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy files between FileSystems.]]>
- </doc>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="srcStatus" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy files between FileSystems.]]>
- </doc>
- </method>
- <method name="copyMerge" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="srcDir" type="org.apache.hadoop.fs.Path"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dstFile" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="addString" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="java.io.File"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy local files to a FileSystem.]]>
- </doc>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="java.io.File"/>
- <param name="deleteSource" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy FileSystem files to local files.]]>
- </doc>
- </method>
- <method name="makeShellPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert a os-native filename to a path that works for the shell.
- @param filename The filename to convert
- @return The unix pathname
- @throws IOException on windows, there can be problems with the subprocess]]>
- </doc>
- </method>
- <method name="makeShellPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert a os-native filename to a path that works for the shell.
- @param file The filename to convert
- @return The unix pathname
- @throws IOException on windows, there can be problems with the subprocess]]>
- </doc>
- </method>
- <method name="makeShellPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.io.File"/>
- <param name="makeCanonicalPath" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert a os-native filename to a path that works for the shell.
- @param file The filename to convert
- @param makeCanonicalPath
- Whether to make canonical path for the file passed
- @return The unix pathname
- @throws IOException on windows, there can be problems with the subprocess]]>
- </doc>
- </method>
- <method name="getDU" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <doc>
- <![CDATA[Takes an input dir and returns the du on that local directory. Very basic
- implementation.
-
- @param dir
- The input dir to get the disk space of this local dir
- @return The total disk space of the input local directory]]>
- </doc>
- </method>
- <method name="unZip"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inFile" type="java.io.File"/>
- <param name="unzipDir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Given a File input it will unzip the file in a the unzip directory
- passed as the second parameter
- @param inFile The zip file as input
- @param unzipDir The unzip directory where to unzip the zip file.
- @throws IOException]]>
- </doc>
- </method>
- <method name="unTar"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inFile" type="java.io.File"/>
- <param name="untarDir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Given a Tar File as input it will untar the file in a the untar directory
- passed as the second parameter
-
- This utility will untar ".tar" files and ".tar.gz","tgz" files.
-
- @param inFile The tar file as input.
- @param untarDir The untar directory where to untar the tar file.
- @throws IOException]]>
- </doc>
- </method>
- <method name="symLink" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="java.lang.String"/>
- <param name="linkname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a soft link between a src and destination
- only on a local disk. HDFS does not support this.
- On Windows, when symlink creation fails due to security
- setting, we will log a warning. The return code in this
- case is 2.
- @param target the target for symlink
- @param linkname the symlink
- @return 0 on success]]>
- </doc>
- </method>
- <method name="chmod" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="java.lang.String"/>
- <param name="perm" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Change the permissions on a filename.
- @param filename the name of the file to change
- @param perm the permission string
- @return the exit code from the command
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="chmod" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="java.lang.String"/>
- <param name="perm" type="java.lang.String"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Change the permissions on a file / directory, recursively, if
- needed.
- @param filename name of the file whose permissions are to change
- @param perm permission string
- @param recursive true, if permissions should be changed recursively
- @return the exit code from the command.
- @throws IOException]]>
- </doc>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.io.File"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the ownership on a file / directory. User name and group name
- cannot both be null.
- @param file the file to change
- @param username the new user owner name
- @param groupname the new group owner name
- @throws IOException]]>
- </doc>
- </method>
- <method name="setReadable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <param name="readable" type="boolean"/>
- <doc>
- <![CDATA[Platform independent implementation for {@link File#setReadable(boolean)}
- File#setReadable does not work as expected on Windows.
- @param f input file
- @param readable
- @return true on success, false otherwise]]>
- </doc>
- </method>
- <method name="setWritable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <param name="writable" type="boolean"/>
- <doc>
- <![CDATA[Platform independent implementation for {@link File#setWritable(boolean)}
- File#setWritable does not work as expected on Windows.
- @param f input file
- @param writable
- @return true on success, false otherwise]]>
- </doc>
- </method>
- <method name="setExecutable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <param name="executable" type="boolean"/>
- <doc>
- <![CDATA[Platform independent implementation for {@link File#setExecutable(boolean)}
- File#setExecutable does not work as expected on Windows.
- Note: revoking execute permission on folders does not have the same
- behavior on Windows as on Unix platforms. Creating, deleting or renaming
- a file within that folder will still succeed on Windows.
- @param f input file
- @param executable
- @return true on success, false otherwise]]>
- </doc>
- </method>
- <method name="canRead" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <doc>
- <![CDATA[Platform independent implementation for {@link File#canRead()}
- @param f input file
- @return On Unix, same as {@link File#canRead()}
- On Windows, true if process has read access on the path]]>
- </doc>
- </method>
- <method name="canWrite" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <doc>
- <![CDATA[Platform independent implementation for {@link File#canWrite()}
- @param f input file
- @return On Unix, same as {@link File#canWrite()}
- On Windows, true if process has write access on the path]]>
- </doc>
- </method>
- <method name="canExecute" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <doc>
- <![CDATA[Platform independent implementation for {@link File#canExecute()}
- @param f input file
- @return On Unix, same as {@link File#canExecute()}
- On Windows, true if process has execute access on the path]]>
- </doc>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set permissions to the required value. Uses the java primitives instead
- of forking if group == other.
- @param f the file to change
- @param permission the new permissions
- @throws IOException]]>
- </doc>
- </method>
- <method name="createLocalTempFile" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="basefile" type="java.io.File"/>
- <param name="prefix" type="java.lang.String"/>
- <param name="isDeleteOnExit" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a tmp file for a base file.
- @param basefile the base file of the tmp
- @param prefix file name prefix of tmp
- @param isDeleteOnExit if true, the tmp will be deleted when the VM exits
- @return a newly created tmp file
- @exception IOException If a tmp file cannot created
- @see java.io.File#createTempFile(String, String, File)
- @see java.io.File#deleteOnExit()]]>
- </doc>
- </method>
- <method name="replaceFile"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="java.io.File"/>
- <param name="target" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move the src file to the name specified by target.
- @param src the source file
- @param target the target file
- @exception IOException If this operation fails]]>
- </doc>
- </method>
- <method name="listFiles" return="java.io.File[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A wrapper for {@link File#listFiles()}. This java.io API returns null
- when a dir is not a directory or for any I/O error. Instead of having
- null check everywhere File#listFiles() is used, we will add utility API
- to get around this problem. For the majority of cases where we prefer
- an IOException to be thrown.
- @param dir directory for which listing should be performed
- @return list of files or empty list
- @exception IOException for invalid directory or for a bad disk.]]>
- </doc>
- </method>
- <method name="list" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A wrapper for {@link File#list()}. This java.io API returns null
- when a dir is not a directory or for any I/O error. Instead of having
- null check everywhere File#list() is used, we will add utility API
- to get around this problem. For the majority of cases where we prefer
- an IOException to be thrown.
- @param dir directory for which listing should be performed
- @return list of file names or empty string list
- @exception IOException for invalid directory or for a bad disk.]]>
- </doc>
- </method>
- <method name="createJarWithClassPath" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inputClassPath" type="java.lang.String"/>
- <param name="pwd" type="org.apache.hadoop.fs.Path"/>
- <param name="callerEnv" type="java.util.Map"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createJarWithClassPath" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inputClassPath" type="java.lang.String"/>
- <param name="pwd" type="org.apache.hadoop.fs.Path"/>
- <param name="targetDir" type="org.apache.hadoop.fs.Path"/>
- <param name="callerEnv" type="java.util.Map"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a jar file at the given path, containing a manifest with a classpath
- that references all specified entries.
-
- Some platforms may have an upper limit on command line length. For example,
- the maximum command line length on Windows is 8191 characters, but the
- length of the classpath may exceed this. To work around this limitation,
- use this method to create a small intermediate jar with a manifest that
- contains the full classpath. It returns the absolute path to the new jar,
- which the caller may set as the classpath for a new process.
-
- Environment variable evaluation is not supported within a jar manifest, so
- this method expands environment variables before inserting classpath entries
- to the manifest. The method parses environment variables according to
- platform-specific syntax (%VAR% on Windows, or $VAR otherwise). On Windows,
- environment variables are case-insensitive. For example, %VAR% and %var%
- evaluate to the same value.
-
- Specifying the classpath in a jar manifest does not support wildcards, so
- this method expands wildcards internally. Any classpath entry that ends
- with * is translated to all files at that path with extension .jar or .JAR.
-
- @param inputClassPath String input classpath to bundle into the jar manifest
- @param pwd Path to working directory to save jar
- @param targetDir path to where the jar execution will have its working dir
- @param callerEnv Map<String, String> caller's environment variables to use
- for expansion
- @return String[] with absolute path to new jar in position 0 and
- unexpanded wild card entry path in position 1
- @throws IOException if there is an I/O error while writing the jar file]]>
- </doc>
- </method>
- <method name="getJarsInDirectory" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns all jars that are in the directory. It is useful in expanding a
- wildcard path to return all jars from the directory to use in a classpath.
- It operates only on local paths.
- @param path the path to the directory. The path may include the wildcard.
- @return the list of jars as URLs, or an empty list if there are no jars, or
- the directory does not exist locally]]>
- </doc>
- </method>
- <method name="getJarsInDirectory" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.String"/>
- <param name="useLocal" type="boolean"/>
- <doc>
- <![CDATA[Returns all jars that are in the directory. It is useful in expanding a
- wildcard path to return all jars from the directory to use in a classpath.
- @param path the path to the directory. The path may include the wildcard.
- @return the list of jars as URLs, or an empty list if there are no jars, or
- the directory does not exist]]>
- </doc>
- </method>
- <method name="compareFs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="destFs" type="org.apache.hadoop.fs.FileSystem"/>
- </method>
- <field name="SYMLINK_NO_PRIVILEGE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A collection of file-processing util methods]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileUtil -->
- <!-- start class org.apache.hadoop.fs.FilterFileSystem -->
- <class name="FilterFileSystem" extends="org.apache.hadoop.fs.FileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FilterFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FilterFileSystem" type="org.apache.hadoop.fs.FileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRawFileSystem" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the raw file system
- @return FileSystem being filtered]]>
- </doc>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called after a new FileSystem instance is constructed.
- @param name a uri whose authority section names the host, port, etc.
- for this FileSystem
- @param conf the configuration]]>
- </doc>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a URI whose scheme and authority identify this FileSystem.]]>
- </doc>
- </method>
- <method name="getCanonicalUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="canonicalizeUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- </method>
- <method name="makeQualified" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Make sure that a path specifies a FileSystem.]]>
- </doc>
- </method>
- <method name="checkPath"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Check that a Path belongs to this FileSystem.]]>
- </doc>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="start" type="long"/>
- <param name="len" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="resolvePath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataInputStream at the indicated Path.
- @param f the file name to open
- @param bufferSize the size of the buffer to be used.]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="concat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="psrcs" type="org.apache.hadoop.fs.Path[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="flags" type="java.util.EnumSet"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="flags" type="java.util.EnumSet"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set replication for an existing file.
-
- @param src file name
- @param replication new replication
- @throws IOException
- @return true if successful;
- false if file does not exist or is a directory]]>
- </doc>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Renames Path src to Path dst. Can take place on local fs
- or remote DFS.]]>
- </doc>
- </method>
- <method name="rename"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="options" type="org.apache.hadoop.fs.Options.Rename[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="truncate" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="newLength" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete a file]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List files in a directory.]]>
- </doc>
- </method>
- <method name="listCorruptFileBlocks" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List files and its block locations in a directory.]]>
- </doc>
- </method>
- <method name="listStatusIterator" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a remote iterator for listing in a directory]]>
- </doc>
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the current working directory for the given file system. All relative
- paths will be resolved relative to it.
-
- @param newDir]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current working directory for the given file system
-
- @return the directory pathname]]>
- </doc>
- </method>
- <method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getStatus" return="org.apache.hadoop.fs.FsStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to FS at
- the given dst name.
- delSrc indicates if the source should be removed]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src files are on the local disk. Add it to FS at
- the given dst name.
- delSrc indicates if the source should be removed]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to FS at
- the given dst name.
- delSrc indicates if the source should be removed]]>
- </doc>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is under FS, and the dst is on the local disk.
- Copy it from FS control to the local dst name.
- delSrc indicates if the src will be removed or not.]]>
- </doc>
- </method>
- <method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a local File that the user can write output to. The caller
- provides both the eventual FS target name and the local working
- file. If the FS is local, we write directly into the target. If
- the FS is remote, we write into the tmp local area.]]>
- </doc>
- </method>
- <method name="completeLocalOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called when we're all done writing to the target. A local FS will
- do nothing, because we've written to exactly the right place. A remote
- FS will copy the contents of tmpLocalFile to the correct target at
- fsOutputFile.]]>
- </doc>
- </method>
- <method name="getUsed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the total size of all files in the filesystem.]]>
- </doc>
- </method>
- <method name="getUsed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the total size of all files from a specified path.]]>
- </doc>
- </method>
- <method name="getDefaultBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDefaultReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getDefaultBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getDefaultReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get file status.]]>
- </doc>
- </method>
- <method name="access"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="mode" type="org.apache.hadoop.fs.permission.FsAction"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSymlink"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="org.apache.hadoop.fs.Path"/>
- <param name="link" type="org.apache.hadoop.fs.Path"/>
- <param name="createParent" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="supportsSymlinks" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="resolveLink" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="length" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setVerifyChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- </method>
- <method name="setWriteChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writeChecksum" type="boolean"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setTimes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="mtime" type="long"/>
- <param name="atime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="primitiveCreate" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="flag" type="java.util.EnumSet"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="primitiveMkdir" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="abdolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getChildFileSystems" return="org.apache.hadoop.fs.FileSystem[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createSnapshot" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="renameSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotOldName" type="java.lang.String"/>
- <param name="snapshotNewName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="deleteSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="modifyAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeDefaultAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getAclStatus" return="org.apache.hadoop.fs.permission.AclStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="byte[]"/>
- <param name="flag" type="java.util.EnumSet"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getXAttr" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="names" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listXAttrs" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setStoragePolicy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="policyName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="unsetStoragePolicy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getStoragePolicy" return="org.apache.hadoop.fs.BlockStoragePolicySpi"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getAllStoragePolicies" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getTrashRoot" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getTrashRoots" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allUsers" type="boolean"/>
- </method>
- <method name="createFile" return="org.apache.hadoop.fs.FSDataOutputStreamBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="appendFile" return="org.apache.hadoop.fs.FSDataOutputStreamBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- </method>
- <field name="fs" type="org.apache.hadoop.fs.FileSystem"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="swapScheme" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A <code>FilterFileSystem</code> contains
- some other file system, which it uses as
- its basic file system, possibly transforming
- the data along the way or providing additional
- functionality. The class <code>FilterFileSystem</code>
- itself simply overrides all methods of
- <code>FileSystem</code> with versions that
- pass all requests to the contained file
- system. Subclasses of <code>FilterFileSystem</code>
- may further override some of these methods
- and may also provide additional methods
- and fields.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FilterFileSystem -->
- <!-- start interface org.apache.hadoop.fs.FsConstants -->
- <interface name="FsConstants" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="LOCAL_FS_URI" type="java.net.URI"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FTP_SCHEME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAX_PATH_LINKS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VIEWFS_URI" type="java.net.URI"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ViewFs: viewFs file system (ie the mount file system on client side)]]>
- </doc>
- </field>
- <field name="VIEWFS_SCHEME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[FileSystem related constants.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.FsConstants -->
- <!-- start class org.apache.hadoop.fs.FSDataInputStream -->
- <class name="FSDataInputStream" extends="java.io.DataInputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.Seekable"/>
- <implements name="org.apache.hadoop.fs.PositionedReadable"/>
- <implements name="org.apache.hadoop.fs.ByteBufferReadable"/>
- <implements name="org.apache.hadoop.fs.HasFileDescriptor"/>
- <implements name="org.apache.hadoop.fs.CanSetDropBehind"/>
- <implements name="org.apache.hadoop.fs.CanSetReadahead"/>
- <implements name="org.apache.hadoop.fs.HasEnhancedByteBufferAccess"/>
- <implements name="org.apache.hadoop.fs.CanUnbuffer"/>
- <implements name="org.apache.hadoop.fs.StreamCapabilities"/>
- <implements name="org.apache.hadoop.fs.ByteBufferPositionedReadable"/>
- <constructor name="FSDataInputStream" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="seek"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="desired" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seek to the given offset.
- @param desired offset to seek to]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the current position in the input stream.
- @return current position in the input stream]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read bytes from the given position in the stream to the given buffer.
- @param position position in the input stream to seek
- @param buffer buffer into which data is read
- @param offset offset into the buffer in which data is written
- @param length maximum number of bytes to read
- @return total number of bytes read into the buffer, or <code>-1</code>
- if there is no more data because the end of the stream has been
- reached]]>
- </doc>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read bytes from the given position in the stream to the given buffer.
- Continues to read until <code>length</code> bytes have been read.
- @param position position in the input stream to seek
- @param buffer buffer into which data is read
- @param offset offset into the buffer in which data is written
- @param length the number of bytes to read
- @throws IOException IO problems
- @throws EOFException If the end of stream is reached while reading.
- If an exception is thrown an undetermined number
- of bytes in the buffer may have been written.]]>
- </doc>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[See {@link #readFully(long, byte[], int, int)}.]]>
- </doc>
- </method>
- <method name="seekToNewSource" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="targetPos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seek to the given position on an alternate copy of the data.
- @param targetPos position to seek to
- @return true if a new source is found, false otherwise]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="java.nio.ByteBuffer"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileDescriptor" return="java.io.FileDescriptor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setReadahead"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="readahead" type="java.lang.Long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- </method>
- <method name="setDropBehind"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dropBehind" type="java.lang.Boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- </method>
- <method name="read" return="java.nio.ByteBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bufferPool" type="org.apache.hadoop.io.ByteBufferPool"/>
- <param name="maxLength" type="int"/>
- <param name="opts" type="java.util.EnumSet"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- </method>
- <method name="read" return="java.nio.ByteBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="bufferPool" type="org.apache.hadoop.io.ByteBufferPool"/>
- <param name="maxLength" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- </method>
- <method name="releaseBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buffer" type="java.nio.ByteBuffer"/>
- </method>
- <method name="unbuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hasCapability" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="java.lang.String"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[String value. Includes the string value of the inner stream
- @return the stream]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buf" type="java.nio.ByteBuffer"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Utility that wraps a {@link FSInputStream} in a {@link DataInputStream}
- and buffers input through a {@link java.io.BufferedInputStream}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSDataInputStream -->
- <!-- start class org.apache.hadoop.fs.FSDataOutputStream -->
- <class name="FSDataOutputStream" extends="java.io.DataOutputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.Syncable"/>
- <implements name="org.apache.hadoop.fs.CanSetDropBehind"/>
- <implements name="org.apache.hadoop.fs.StreamCapabilities"/>
- <constructor name="FSDataOutputStream" type="java.io.OutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="FSDataOutputStream" type="java.io.OutputStream, org.apache.hadoop.fs.FileSystem.Statistics"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="FSDataOutputStream" type="java.io.OutputStream, org.apache.hadoop.fs.FileSystem.Statistics, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the current position in the output stream.
- @return the current position in the output stream]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the underlying output stream.]]>
- </doc>
- </method>
- <method name="hasCapability" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="java.lang.String"/>
- </method>
- <method name="sync"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="hflush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="hsync"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setDropBehind"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dropBehind" type="java.lang.Boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Utility that wraps a {@link OutputStream} in a {@link DataOutputStream}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSDataOutputStream -->
- <!-- start class org.apache.hadoop.fs.FSDataOutputStreamBuilder -->
- <class name="FSDataOutputStreamBuilder" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FSDataOutputStreamBuilder" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.]]>
- </doc>
- </constructor>
- <method name="getThisBuilder" return="B"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the concrete implementation of the builder instance.]]>
- </doc>
- </method>
- <method name="getFS" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getPermission" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="permission" return="B"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="perm" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <doc>
- <![CDATA[Set permission for the file.]]>
- </doc>
- </method>
- <method name="getBufferSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="bufferSize" return="B"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bufSize" type="int"/>
- <doc>
- <![CDATA[Set the size of the buffer to be used.]]>
- </doc>
- </method>
- <method name="getReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="replication" return="B"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="replica" type="short"/>
- <doc>
- <![CDATA[Set replication factor.]]>
- </doc>
- </method>
- <method name="getBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="blockSize" return="B"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="blkSize" type="long"/>
- <doc>
- <![CDATA[Set block size.]]>
- </doc>
- </method>
- <method name="isRecursive" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return true to create the parent directories if they do not exist.]]>
- </doc>
- </method>
- <method name="recursive" return="B"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create the parent directory if they do not exist.]]>
- </doc>
- </method>
- <method name="getProgress" return="org.apache.hadoop.util.Progressable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="progress" return="B"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="prog" type="org.apache.hadoop.util.Progressable"/>
- <doc>
- <![CDATA[Set the facility of reporting progress.]]>
- </doc>
- </method>
- <method name="getFlags" return="java.util.EnumSet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="create" return="B"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an FSDataOutputStream at the specified path.]]>
- </doc>
- </method>
- <method name="overwrite" return="B"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="overwrite" type="boolean"/>
- <doc>
- <![CDATA[Set to true to overwrite the existing file.
- Set it to false, an exception will be thrown when calling {@link #build()}
- if the file exists.]]>
- </doc>
- </method>
- <method name="append" return="B"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Append to an existing file (optional operation).]]>
- </doc>
- </method>
- <method name="getChecksumOpt" return="org.apache.hadoop.fs.Options.ChecksumOpt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="checksumOpt" return="B"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="chksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
- <doc>
- <![CDATA[Set checksum opt.]]>
- </doc>
- </method>
- <method name="build" return="S"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the FSDataOutputStream to write on the file system.
- @throws HadoopIllegalArgumentException if the parameters are not valid.
- @throws IOException on errors when file system creates or appends the file.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Builder for {@link FSDataOutputStream} and its subclasses.
- It is used to create {@link FSDataOutputStream} when creating a new file or
- appending an existing file on {@link FileSystem}.
- By default, it does not create parent directory that do not exist.
- {@link FileSystem#createNonRecursive(Path, boolean, int, short, long,
- Progressable)}.
- To create missing parent directory, use {@link #recursive()}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSDataOutputStreamBuilder -->
- <!-- start class org.apache.hadoop.fs.FSError -->
- <class name="FSError" extends="java.lang.Error"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Thrown for unexpected filesystem errors, presumed to reflect disk errors
- in the native filesystem.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSError -->
- <!-- start class org.apache.hadoop.fs.FSInputStream -->
- <class name="FSInputStream" extends="java.io.InputStream"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.Seekable"/>
- <implements name="org.apache.hadoop.fs.PositionedReadable"/>
- <constructor name="FSInputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="seek"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seek to the given offset from the start of the file.
- The next read() will be from that location. Can't
- seek past the end of the file.]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the current offset from the start of the file]]>
- </doc>
- </method>
- <method name="seekToNewSource" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="targetPos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seeks a different copy of the data. Returns true if
- found a new source, false otherwise.]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="validatePositionedReadArgs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="EOFException" type="java.io.EOFException"/>
- <doc>
- <![CDATA[Validation code, available for use in subclasses.
- @param position position: if negative an EOF exception is raised
- @param buffer destination buffer
- @param offset offset within the buffer
- @param length length of bytes to read
- @throws EOFException if the position is negative
- @throws IndexOutOfBoundsException if there isn't space for the amount of
- data requested.
- @throws IllegalArgumentException other arguments are invalid.]]>
- </doc>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[FSInputStream is a generic old InputStream with a little bit
- of RAF-style seek ability.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSInputStream -->
- <!-- start class org.apache.hadoop.fs.FsServerDefaults -->
- <class name="FsServerDefaults" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="FsServerDefaults"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FsServerDefaults" type="long, int, int, short, int, boolean, long, org.apache.hadoop.util.DataChecksum.Type"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FsServerDefaults" type="long, int, int, short, int, boolean, long, org.apache.hadoop.util.DataChecksum.Type, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FsServerDefaults" type="long, int, int, short, int, boolean, long, org.apache.hadoop.util.DataChecksum.Type, java.lang.String, byte"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getBytesPerChecksum" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getWritePacketSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFileBufferSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getEncryptDataTransfer" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTrashInterval" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getChecksumType" return="org.apache.hadoop.util.DataChecksum.Type"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getKeyProviderUri" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDefaultStoragePolicyId" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Provides server default configuration values to clients.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FsServerDefaults -->
- <!-- start class org.apache.hadoop.fs.FsStatus -->
- <class name="FsStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="FsStatus" type="long, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a FsStatus object, using the specified statistics]]>
- </doc>
- </constructor>
- <method name="getCapacity" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the capacity in bytes of the file system]]>
- </doc>
- </method>
- <method name="getUsed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the number of bytes used on the file system]]>
- </doc>
- </method>
- <method name="getRemaining" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the number of remaining bytes on the file system]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This class is used to represent the capacity, free and used space on a
- {@link FileSystem}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FsStatus -->
- <!-- start class org.apache.hadoop.fs.GlobalStorageStatistics -->
- <class name="GlobalStorageStatistics" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.GlobalStorageStatistics[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.GlobalStorageStatistics"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="get" return="org.apache.hadoop.fs.StorageStatistics"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the StorageStatistics object with the given name.
- @param name The storage statistics object name.
- @return The StorageStatistics object with the given name, or
- null if there is none.]]>
- </doc>
- </method>
- <method name="put" return="org.apache.hadoop.fs.StorageStatistics"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="provider" type="org.apache.hadoop.fs.GlobalStorageStatistics.StorageStatisticsProvider"/>
- <doc>
- <![CDATA[Create or return the StorageStatistics object with the given name.
- @param name The storage statistics object name.
- @param provider An object which can create a new StorageStatistics
- object if needed.
- @return The StorageStatistics object with the given name.
- @throws RuntimeException If the StorageStatisticsProvider provides a null
- object or a new StorageStatistics object with the
- wrong name.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reset all global storage statistics.]]>
- </doc>
- </method>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get an iterator that we can use to iterate throw all the global storage
- statistics objects.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Stores global storage statistics objects.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.GlobalStorageStatistics -->
- <!-- start class org.apache.hadoop.fs.GlobFilter -->
- <class name="GlobFilter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.PathFilter"/>
- <constructor name="GlobFilter" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates a glob filter with the specified file pattern.
- @param filePattern the file pattern.
- @throws IOException thrown if the file pattern is incorrect.]]>
- </doc>
- </constructor>
- <constructor name="GlobFilter" type="java.lang.String, org.apache.hadoop.fs.PathFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates a glob filter with the specified file pattern and an user filter.
- @param filePattern the file pattern.
- @param filter user filter in addition to the glob pattern.
- @throws IOException thrown if the file pattern is incorrect.]]>
- </doc>
- </constructor>
- <method name="hasPattern" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- </method>
- <doc>
- <![CDATA[A filter for POSIX glob pattern with brace expansions.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.GlobFilter -->
- <!-- start class org.apache.hadoop.fs.InvalidPathException -->
- <class name="InvalidPathException" extends="org.apache.hadoop.HadoopIllegalArgumentException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidPathException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs exception with the specified detail message.
-
- @param path invalid path.]]>
- </doc>
- </constructor>
- <constructor name="InvalidPathException" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs exception with the specified detail message.
-
- @param path invalid path.
- @param reason Reason <code>path</code> is invalid]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Path string is invalid either because it has invalid characters or due to
- other file system specific reasons.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.InvalidPathException -->
- <!-- start class org.apache.hadoop.fs.LocalFileSystem -->
- <class name="LocalFileSystem" extends="org.apache.hadoop.fs.ChecksumFileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LocalFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="LocalFileSystem" type="org.apache.hadoop.fs.FileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getScheme" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the protocol scheme for the FileSystem.
- <p/>
- @return <code>file</code>]]>
- </doc>
- </method>
- <method name="getRaw" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="pathToFile" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Convert a path to a File.]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="reportChecksumFailure" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="in" type="org.apache.hadoop.fs.FSDataInputStream"/>
- <param name="inPos" type="long"/>
- <param name="sums" type="org.apache.hadoop.fs.FSDataInputStream"/>
- <param name="sumsPos" type="long"/>
- <doc>
- <![CDATA[Moves files to a bad file directory on the same device, so that their
- storage will not be reused.]]>
- </doc>
- </method>
- <method name="supportsSymlinks" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createSymlink"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="org.apache.hadoop.fs.Path"/>
- <param name="link" type="org.apache.hadoop.fs.Path"/>
- <param name="createParent" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implement the FileSystem API for the checksumed local filesystem.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.LocalFileSystem -->
- <!-- start class org.apache.hadoop.fs.LocatedFileStatus -->
- <class name="LocatedFileStatus" extends="org.apache.hadoop.fs.FileStatus"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LocatedFileStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="LocatedFileStatus" type="org.apache.hadoop.fs.FileStatus, org.apache.hadoop.fs.BlockLocation[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor
- @param stat a file status
- @param locations a file's block locations]]>
- </doc>
- </constructor>
- <constructor name="LocatedFileStatus" type="long, boolean, int, long, long, long, org.apache.hadoop.fs.permission.FsPermission, java.lang.String, java.lang.String, org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path, org.apache.hadoop.fs.BlockLocation[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
-
- @param length a file's length
- @param isdir if the path is a directory
- @param block_replication the file's replication factor
- @param blocksize a file's block size
- @param modification_time a file's modification time
- @param access_time a file's access time
- @param permission a file's permission
- @param owner a file's owner
- @param group a file's group
- @param symlink symlink if the path is a symbolic link
- @param path the path's qualified name
- @param locations a file's block locations]]>
- </doc>
- </constructor>
- <method name="getBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the file's block locations
- @return the file's block locations]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.fs.FileStatus"/>
- <doc>
- <![CDATA[Compare this FileStatus to another FileStatus
- @param o the FileStatus to be compared.
- @return a negative integer, zero, or a positive integer as this object
- is less than, equal to, or greater than the specified object.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compare if this object is equal to another object
- @param o the object to be compared.
- @return true if two file status has the same path name; false if not.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a hash code value for the object, which is defined as
- the hash code of the path name.
- @return a hash code value for the path name.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class defines a FileStatus that includes a file's block locations.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.LocatedFileStatus -->
- <!-- start class org.apache.hadoop.fs.Options -->
- <class name="Options" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="Options"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This class contains options related to file system operations.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.Options -->
- <!-- start class org.apache.hadoop.fs.ParentNotDirectoryException -->
- <class name="ParentNotDirectoryException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ParentNotDirectoryException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ParentNotDirectoryException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Indicates that the parent of specified Path is not a directory
- as expected.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ParentNotDirectoryException -->
- <!-- start class org.apache.hadoop.fs.Path -->
- <class name="Path" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="Path" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new Path based on the child path resolved against the parent path.
- @param parent the parent path
- @param child the child path]]>
- </doc>
- </constructor>
- <constructor name="Path" type="org.apache.hadoop.fs.Path, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new Path based on the child path resolved against the parent path.
- @param parent the parent path
- @param child the child path]]>
- </doc>
- </constructor>
- <constructor name="Path" type="java.lang.String, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new Path based on the child path resolved against the parent path.
- @param parent the parent path
- @param child the child path]]>
- </doc>
- </constructor>
- <constructor name="Path" type="org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new Path based on the child path resolved against the parent path.
- @param parent the parent path
- @param child the child path]]>
- </doc>
- </constructor>
- <constructor name="Path" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[Construct a path from a String. Path strings are URIs, but with
- unescaped elements and some additional normalization.
- @param pathString the path string]]>
- </doc>
- </constructor>
- <constructor name="Path" type="java.net.URI"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a path from a URI
- @param aUri the source URI]]>
- </doc>
- </constructor>
- <constructor name="Path" type="java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a Path from components.
- @param scheme the scheme
- @param authority the authority
- @param path the path]]>
- </doc>
- </constructor>
- <method name="getPathWithoutSchemeAndAuthority" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Return a version of the given Path without the scheme information.
- @param path the source Path
- @return a copy of this Path without the scheme information]]>
- </doc>
- </method>
- <method name="mergePaths" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path1" type="org.apache.hadoop.fs.Path"/>
- <param name="path2" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Merge 2 paths such that the second path is appended relative to the first.
- The returned path has the scheme and authority of the first path. On
- Windows, the drive specification in the second path is discarded.
-
- @param path1 the first path
- @param path2 the second path, to be appended relative to path1
- @return the merged path]]>
- </doc>
- </method>
- <method name="isWindowsAbsolutePath" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathString" type="java.lang.String"/>
- <param name="slashed" type="boolean"/>
- <doc>
- <![CDATA[Determine whether a given path string represents an absolute path on
- Windows. e.g. "C:/a/b" is an absolute path. "C:a/b" is not.
- @param pathString the path string to evaluate
- @param slashed true if the given path is prefixed with "/"
- @return true if the supplied path looks like an absolute path with a Windows
- drive-specifier]]>
- </doc>
- </method>
- <method name="toUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convert this Path to a URI.
- @return this Path as a URI]]>
- </doc>
- </method>
- <method name="getFileSystem" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the FileSystem that owns this Path.
- @param conf the configuration to use when resolving the FileSystem
- @return the FileSystem that owns this Path
- @throws java.io.IOException thrown if there's an issue resolving the
- FileSystem]]>
- </doc>
- </method>
- <method name="isAbsoluteAndSchemeAuthorityNull" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the path component (i.e. directory) of this URI is
- absolute <strong>and</strong> the scheme is null, <b>and</b> the authority
- is null.
- @return whether the path is absolute and the URI has no scheme nor
- authority parts]]>
- </doc>
- </method>
- <method name="isUriPathAbsolute" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the path component (i.e. directory) of this URI is
- absolute.
- @return whether this URI's path is absolute]]>
- </doc>
- </method>
- <method name="isAbsolute" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the path component (i.e. directory) of this URI is
- absolute. This method is a wrapper for {@link #isUriPathAbsolute()}.
- @return whether this URI's path is absolute]]>
- </doc>
- </method>
- <method name="isRoot" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if and only if this path represents the root of a file system.
- @return true if and only if this path represents the root of a file system]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the final component of this path.
- @return the final component of this path]]>
- </doc>
- </method>
- <method name="getParent" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the parent of a path or null if at root.
- @return the parent of a path or null if at root]]>
- </doc>
- </method>
- <method name="suffix" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="suffix" type="java.lang.String"/>
- <doc>
- <![CDATA[Adds a suffix to the final name in the path.
- @param suffix the suffix to add
- @return a new path with the suffix added]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="depth" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of elements in this path.
- @return the number of elements in this path]]>
- </doc>
- </method>
- <method name="makeQualified" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #makeQualified(URI, Path)}">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <doc>
- <![CDATA[Returns a qualified path object for the {@link FileSystem}'s working
- directory.
-
- @param fs the target FileSystem
- @return a qualified path object for the FileSystem's working directory
- @deprecated use {@link #makeQualified(URI, Path)}]]>
- </doc>
- </method>
- <field name="SEPARATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The directory separator, a slash.]]>
- </doc>
- </field>
- <field name="SEPARATOR_CHAR" type="char"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The directory separator, a slash, as a character.]]>
- </doc>
- </field>
- <field name="CUR_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The current directory, ".".]]>
- </doc>
- </field>
- <field name="WINDOWS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the current host is a Windows machine.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Names a file or directory in a {@link FileSystem}.
- Path strings use slash as the directory separator.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.Path -->
- <!-- start interface org.apache.hadoop.fs.PathFilter -->
- <interface name="PathFilter" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Tests whether or not the specified abstract pathname should be
- included in a pathname list.
- @param path The abstract pathname to be tested
- @return <code>true</code> if and only if <code>pathname</code>
- should be included]]>
- </doc>
- </method>
- </interface>
- <!-- end interface org.apache.hadoop.fs.PathFilter -->
- <!-- start interface org.apache.hadoop.fs.PositionedReadable -->
- <interface name="PositionedReadable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read up to the specified number of bytes, from a given
- position within a file, and return the number of bytes read. This does not
- change the current offset of a file, and is thread-safe.
- <i>Warning: Not all filesystems satisfy the thread-safety requirement.</i>
- @param position position within file
- @param buffer destination buffer
- @param offset offset in the buffer
- @param length number of bytes to read
- @return actual number of bytes read; -1 means "none"
- @throws IOException IO problems.]]>
- </doc>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the specified number of bytes, from a given
- position within a file. This does not
- change the current offset of a file, and is thread-safe.
- <i>Warning: Not all filesystems satisfy the thread-safety requirement.</i>
- @param position position within file
- @param buffer destination buffer
- @param offset offset in the buffer
- @param length number of bytes to read
- @throws IOException IO problems.
- @throws EOFException the end of the data was reached before
- the read operation completed]]>
- </doc>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read number of bytes equal to the length of the buffer, from a given
- position within a file. This does not
- change the current offset of a file, and is thread-safe.
- <i>Warning: Not all filesystems satisfy the thread-safety requirement.</i>
- @param position position within file
- @param buffer destination buffer
- @throws IOException IO problems.
- @throws EOFException the end of the data was reached before
- the read operation completed]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Stream that permits positional reading.
- Implementations are required to implement thread-safe operations; this may
- be supported by concurrent access to the data, or by using a synchronization
- mechanism to serialize access.
- Not all implementations meet this requirement. Those that do not cannot
- be used as a backing store for some applications, such as Apache HBase.
- Independent of whether or not they are thread safe, some implementations
- may make the intermediate state of the system, specifically the position
- obtained in {@code Seekable.getPos()} visible.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.PositionedReadable -->
- <!-- start class org.apache.hadoop.fs.QuotaUsage -->
- <class name="QuotaUsage" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="QuotaUsage"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <constructor name="QuotaUsage" type="org.apache.hadoop.fs.QuotaUsage.Builder"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Build the instance based on the builder.]]>
- </doc>
- </constructor>
- <method name="setQuota"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="quota" type="long"/>
- </method>
- <method name="setSpaceConsumed"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="spaceConsumed" type="long"/>
- </method>
- <method name="setSpaceQuota"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="spaceQuota" type="long"/>
- </method>
- <method name="getFileAndDirectoryCount" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the directory count.]]>
- </doc>
- </method>
- <method name="getQuota" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the directory quota.]]>
- </doc>
- </method>
- <method name="getSpaceConsumed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return (disk) space consumed.]]>
- </doc>
- </method>
- <method name="getSpaceQuota" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return (disk) space quota.]]>
- </doc>
- </method>
- <method name="getTypeQuota" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="org.apache.hadoop.fs.StorageType"/>
- <doc>
- <![CDATA[Return storage type quota.]]>
- </doc>
- </method>
- <method name="getTypeConsumed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="org.apache.hadoop.fs.StorageType"/>
- <doc>
- <![CDATA[Return storage type consumed.]]>
- </doc>
- </method>
- <method name="isTypeQuotaSet" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return true if any storage type quota has been set.]]>
- </doc>
- </method>
- <method name="isTypeConsumedAvailable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return true if any storage type consumption information is available.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="to" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHeader" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the header of the output.
- @return the header of the output]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hOption" type="boolean"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hOption" type="boolean"/>
- <param name="tOption" type="boolean"/>
- <param name="types" type="java.util.List"/>
- <doc>
- <![CDATA[Return the string representation of the object in the output format.
- if hOption is false file sizes are returned in bytes
- if hOption is true file sizes are returned in human readable
- @param hOption a flag indicating if human readable output if to be used
- @return the string representation of the object]]>
- </doc>
- </method>
- <method name="getQuotaUsage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="hOption" type="boolean"/>
- </method>
- <method name="getTypesQuotaUsage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="hOption" type="boolean"/>
- <param name="types" type="java.util.List"/>
- </method>
- <method name="getStorageTypeHeader" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="storageTypes" type="java.util.List"/>
- <doc>
- <![CDATA[return the header of with the StorageTypes.
- @param storageTypes
- @return storage header string]]>
- </doc>
- </method>
- <field name="QUOTA_STRING_FORMAT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Output format:
- <----12----> <----15----> <----15----> <----15----> <-------18------->
- QUOTA REMAINING_QUATA SPACE_QUOTA SPACE_QUOTA_REM FILE_NAME]]>
- </doc>
- </field>
- <field name="SPACE_QUOTA_STRING_FORMAT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="QUOTA_HEADER_FIELDS" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="QUOTA_HEADER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Store the quota usage of a directory.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.QuotaUsage -->
- <!-- start class org.apache.hadoop.fs.RawLocalFileSystem -->
- <class name="RawLocalFileSystem" extends="org.apache.hadoop.fs.FileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RawLocalFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="useStatIfAvailable"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="pathToFile" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Convert a path to a File.]]>
- </doc>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createOutputStream" return="java.io.OutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="append" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createOutputStreamWithMode" return="java.io.OutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="append" type="boolean"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="flags" type="java.util.EnumSet"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="handleEmptyDstDirectoryOnWindows" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="srcFile" type="java.io.File"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="dstFile" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="truncate" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="newLength" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the given path to a file or directory.
- @param p the path to delete
- @param recursive to delete sub-directories
- @return true if the file or directory and all its contents were deleted
- @throws IOException if p is non-empty and recursive is false]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkOneDir" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="p2f" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkOneDirWithMode" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="p2f" type="java.io.File"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates the specified directory hierarchy. Does not
- treat existence as an error.]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the working directory to the given directory.]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getStatus" return="org.apache.hadoop.fs.FsStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="moveFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="completeLocalOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsWorkingFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Use the command chown to set owner.]]>
- </doc>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Use the command chmod to set permission.]]>
- </doc>
- </method>
- <method name="setTimes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="mtime" type="long"/>
- <param name="atime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Sets the {@link Path}'s last modified time and last access time to
- the given valid times.
- @param mtime the modification time to set (only if no less than zero).
- @param atime the access time to set (only if no less than zero).
- @throws IOException if setting the times fails.]]>
- </doc>
- </method>
- <method name="supportsSymlinks" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createSymlink"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="org.apache.hadoop.fs.Path"/>
- <param name="link" type="org.apache.hadoop.fs.Path"/>
- <param name="createParent" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a FileStatus representing the given path. If the path refers
- to a symlink return a FileStatus representing the link rather than
- the object the link refers to.]]>
- </doc>
- </method>
- <method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implement the FileSystem API for the raw local filesystem.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.RawLocalFileSystem -->
- <!-- start class org.apache.hadoop.fs.ReadOption -->
- <class name="ReadOption" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.ReadOption[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.ReadOption"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Options that can be used when reading from a FileSystem.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ReadOption -->
- <!-- start interface org.apache.hadoop.fs.Seekable -->
- <interface name="Seekable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="seek"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seek to the given offset from the start of the file.
- The next read() will be from that location. Can't
- seek past the end of the file.]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the current offset from the start of the file]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Stream that permits seeking.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.Seekable -->
- <!-- start class org.apache.hadoop.fs.StorageStatistics -->
- <class name="StorageStatistics" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StorageStatistics" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of this StorageStatistics object.]]>
- </doc>
- </method>
- <method name="getScheme" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the associated file system scheme if this is scheme specific,
- else return null.]]>
- </doc>
- </method>
- <method name="getLongStatistics" return="java.util.Iterator"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get an iterator over all the currently tracked long statistics.
- The values returned will depend on the type of FileSystem or FileContext
- object. The values do not necessarily reflect a snapshot in time.]]>
- </doc>
- </method>
- <method name="getLong" return="java.lang.Long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value of a statistic.
- @return null if the statistic is not being tracked or is not a
- long statistic. The value of the statistic, otherwise.]]>
- </doc>
- </method>
- <method name="isTracked" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <doc>
- <![CDATA[Return true if a statistic is being tracked.
- @return True only if the statistic is being tracked.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reset all the statistic data.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[StorageStatistics contains statistics data for a FileSystem or FileContext
- instance.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.StorageStatistics -->
- <!-- start class org.apache.hadoop.fs.StorageType -->
- <class name="StorageType" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.StorageType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.StorageType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="isTransient" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="supportTypeQuota" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isMovable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="asList" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMovableTypes" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTypesSupportingQuota" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="parseStorageType" return="org.apache.hadoop.fs.StorageType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- </method>
- <method name="parseStorageType" return="org.apache.hadoop.fs.StorageType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- </method>
- <field name="DEFAULT" type="org.apache.hadoop.fs.StorageType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EMPTY_ARRAY" type="org.apache.hadoop.fs.StorageType[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Defines the types of supported storage media. The default storage
- medium is assumed to be DISK.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.StorageType -->
- <!-- start interface org.apache.hadoop.fs.StreamCapabilities -->
- <interface name="StreamCapabilities" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="hasCapability" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="java.lang.String"/>
- <doc>
- <![CDATA[Query the stream for a specific capability.
- @param capability string to query the stream support for.
- @return True if the stream supports capability.]]>
- </doc>
- </method>
- <field name="HFLUSH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stream hflush capability implemented by {@link Syncable#hflush()}.]]>
- </doc>
- </field>
- <field name="HSYNC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stream hsync capability implemented by {@link Syncable#hsync()}.]]>
- </doc>
- </field>
- <field name="READAHEAD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stream setReadahead capability implemented by
- {@link CanSetReadahead#setReadahead(Long)}.]]>
- </doc>
- </field>
- <field name="DROPBEHIND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stream setDropBehind capability implemented by
- {@link CanSetDropBehind#setDropBehind(Boolean)}.]]>
- </doc>
- </field>
- <field name="UNBUFFER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stream unbuffer capability implemented by {@link CanUnbuffer#unbuffer()}.]]>
- </doc>
- </field>
- <field name="READBYTEBUFFER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stream read(ByteBuffer) capability implemented by
- {@link ByteBufferReadable#read(java.nio.ByteBuffer)}.]]>
- </doc>
- </field>
- <field name="PREADBYTEBUFFER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stream read(long, ByteBuffer) capability implemented by
- {@link ByteBufferPositionedReadable#read(long, java.nio.ByteBuffer)}.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Interface to query streams for supported capabilities.
- Capability strings must be in lower case.
- Constant strings are chosen over enums in order to allow other file systems
- to define their own capabilities.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.StreamCapabilities -->
- <!-- start class org.apache.hadoop.fs.StreamCapabilitiesPolicy -->
- <class name="StreamCapabilitiesPolicy" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StreamCapabilitiesPolicy"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="unbuffer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <doc>
- <![CDATA[Implement the policy for {@link CanUnbuffer#unbuffer()}.
- @param in the input stream]]>
- </doc>
- </method>
- <field name="CAN_UNBUFFER_NOT_IMPLEMENTED_MESSAGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Static methods to implement policies for {@link StreamCapabilities}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.StreamCapabilitiesPolicy -->
- <!-- start interface org.apache.hadoop.fs.Syncable -->
- <interface name="Syncable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="sync"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="As of HADOOP 0.21.0, replaced by hflush">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated As of HADOOP 0.21.0, replaced by hflush
- @see #hflush()]]>
- </doc>
- </method>
- <method name="hflush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Flush out the data in client's user buffer. After the return of
- this call, new readers will see the data.
- @throws IOException if any error occurs]]>
- </doc>
- </method>
- <method name="hsync"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Similar to posix fsync, flush out the data in client's user buffer
- all the way to the disk device (but the disk may have it in its cache).
- @throws IOException if error occurs]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This interface for flush/sync operation.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.Syncable -->
- <!-- start class org.apache.hadoop.fs.Trash -->
- <class name="Trash" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Trash" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a trash can accessor.
- @param conf a Configuration]]>
- </doc>
- </constructor>
- <constructor name="Trash" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a trash can accessor for the FileSystem provided.
- @param fs the FileSystem
- @param conf a Configuration]]>
- </doc>
- </constructor>
- <method name="moveToAppropriateTrash" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[In case of the symlinks or mount points, one has to move the appropriate
- trashbin in the actual volume of the path p being deleted.
- Hence we get the file system of the fully-qualified resolved-path and
- then move the path p to the trashbin in that volume,
- @param fs - the filesystem of path p
- @param p - the path being deleted - to be moved to trasg
- @param conf - configuration
- @return false if the item is already in the trash or trash is disabled
- @throws IOException on error]]>
- </doc>
- </method>
- <method name="isEnabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns whether the trash is enabled for this filesystem]]>
- </doc>
- </method>
- <method name="moveToTrash" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move a file or directory to the current trash directory.
- @return false if the item is already in the trash or trash is disabled]]>
- </doc>
- </method>
- <method name="checkpoint"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a trash checkpoint.]]>
- </doc>
- </method>
- <method name="expunge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete old checkpoint(s).]]>
- </doc>
- </method>
- <method name="getEmptier" return="java.lang.Runnable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a {@link Runnable} that periodically empties the trash of all
- users, intended to be run by the superuser.]]>
- </doc>
- </method>
- <method name="getCurrentTrashDir" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Provides a trash facility which supports pluggable Trash policies.
- See the implementation of the configured TrashPolicy for more
- details.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.Trash -->
- <!-- start class org.apache.hadoop.fs.TrashPolicy -->
- <class name="TrashPolicy" extends="org.apache.hadoop.conf.Configured"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TrashPolicy"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #initialize(Configuration, FileSystem)} instead.">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="home" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Used to setup the trash policy. Must be implemented by all TrashPolicy
- implementations.
- @param conf the configuration to be used
- @param fs the filesystem to be used
- @param home the home directory
- @deprecated Use {@link #initialize(Configuration, FileSystem)} instead.]]>
- </doc>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <doc>
- <![CDATA[Used to setup the trash policy. Must be implemented by all TrashPolicy
- implementations. Different from initialize(conf, fs, home), this one does
- not assume trash always under /user/$USER due to HDFS encryption zone.
- @param conf the configuration to be used
- @param fs the filesystem to be used]]>
- </doc>
- </method>
- <method name="isEnabled" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns whether the Trash Policy is enabled for this filesystem.]]>
- </doc>
- </method>
- <method name="moveToTrash" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move a file or directory to the current trash directory.
- @return false if the item is already in the trash or trash is disabled]]>
- </doc>
- </method>
- <method name="createCheckpoint"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a trash checkpoint.]]>
- </doc>
- </method>
- <method name="deleteCheckpoint"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete old trash checkpoint(s).]]>
- </doc>
- </method>
- <method name="getCurrentTrashDir" return="org.apache.hadoop.fs.Path"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current working directory of the Trash Policy
- This API does not work with files deleted from encryption zone when HDFS
- data encryption at rest feature is enabled as rename file between
- encryption zones or encryption zone and non-encryption zone is not allowed.
- The caller is recommend to use the new API
- TrashPolicy#getCurrentTrashDir(Path path).
- It returns the trash location correctly for the path specified no matter
- the path is in encryption zone or not.]]>
- </doc>
- </method>
- <method name="getCurrentTrashDir" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the current trash directory for path specified based on the Trash
- Policy
- @param path path to be deleted
- @return current trash directory for the path to be deleted
- @throws IOException]]>
- </doc>
- </method>
- <method name="getEmptier" return="java.lang.Runnable"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a {@link Runnable} that periodically empties the trash of all
- users, intended to be run by the superuser.]]>
- </doc>
- </method>
- <method name="getInstance" return="org.apache.hadoop.fs.TrashPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #getInstance(Configuration, FileSystem)} instead.">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="home" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Get an instance of the configured TrashPolicy based on the value
- of the configuration parameter fs.trash.classname.
- @param conf the configuration to be used
- @param fs the file system to be used
- @param home the home directory
- @return an instance of TrashPolicy
- @deprecated Use {@link #getInstance(Configuration, FileSystem)} instead.]]>
- </doc>
- </method>
- <method name="getInstance" return="org.apache.hadoop.fs.TrashPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <doc>
- <![CDATA[Get an instance of the configured TrashPolicy based on the value
- of the configuration parameter fs.trash.classname.
- @param conf the configuration to be used
- @param fs the file system to be used
- @return an instance of TrashPolicy]]>
- </doc>
- </method>
- <field name="fs" type="org.apache.hadoop.fs.FileSystem"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="trash" type="org.apache.hadoop.fs.Path"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="deletionInterval" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This interface is used for implementing different Trash policies.
- Provides factory method to create instances of the configured Trash policy.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.TrashPolicy -->
- <!-- start class org.apache.hadoop.fs.UnsupportedFileSystemException -->
- <class name="UnsupportedFileSystemException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UnsupportedFileSystemException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs exception with the specified detail message.
- @param message exception message.]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[File system for a given file system name/scheme is not supported]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.UnsupportedFileSystemException -->
- <!-- start class org.apache.hadoop.fs.XAttrCodec -->
- <class name="XAttrCodec" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.XAttrCodec[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.XAttrCodec"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="decodeValue" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Decode string representation of a value and check whether it's
- encoded. If the given string begins with 0x or 0X, it expresses
- a hexadecimal number. If the given string begins with 0s or 0S,
- base64 encoding is expected. If the given string is enclosed in
- double quotes, the inner string is treated as text. Otherwise
- the given string is treated as text.
- @param value string representation of the value.
- @return byte[] the value
- @throws IOException]]>
- </doc>
- </method>
- <method name="encodeValue" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="byte[]"/>
- <param name="encoding" type="org.apache.hadoop.fs.XAttrCodec"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Encode byte[] value to string representation with encoding.
- Values encoded as text strings are enclosed in double quotes (\"),
- while strings encoded as hexadecimal and base64 are prefixed with
- 0x and 0s, respectively.
- @param value byte[] value
- @param encoding
- @return String string representation of value
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The value of <code>XAttr</code> is byte[], this class is to
- covert byte[] to some kind of string representation or convert back.
- String representation is convenient for display and input. For example
- display in screen as shell response and json response, input as http
- or shell parameter.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.XAttrCodec -->
- <!-- start class org.apache.hadoop.fs.XAttrSetFlag -->
- <class name="XAttrSetFlag" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.XAttrSetFlag[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.XAttrSetFlag"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="validate"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="xAttrName" type="java.lang.String"/>
- <param name="xAttrExists" type="boolean"/>
- <param name="flag" type="java.util.EnumSet"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.fs.XAttrSetFlag -->
- <doc>
- <![CDATA[An abstract file system API.]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.fs.crypto">
- </package>
- <package name="org.apache.hadoop.fs.ftp">
- <!-- start class org.apache.hadoop.fs.ftp.FTPException -->
- <class name="FTPException" extends="java.lang.RuntimeException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FTPException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FTPException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FTPException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A class to wrap a {@link Throwable} into a Runtime Exception.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ftp.FTPException -->
- <!-- start class org.apache.hadoop.fs.ftp.FTPFileSystem -->
- <class name="FTPFileSystem" extends="org.apache.hadoop.fs.FileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FTPFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getScheme" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the protocol scheme for the FileSystem.
- <p/>
- @return <code>ftp</code>]]>
- </doc>
- </method>
- <method name="getDefaultPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default port for this FTPFileSystem.
- @return the default port]]>
- </doc>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A stream obtained via this call must be closed before using other APIs of
- this class or else the invocation will block.]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This optional operation is not yet supported.]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newDir" type="org.apache.hadoop.fs.Path"/>
- </method>
- <field name="LOG" type="org.slf4j.Logger"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_BUFFER_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_BLOCK_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_FTP_USER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_FTP_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_FTP_HOST_PORT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_FTP_PASSWORD_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_FTP_DATA_CONNECTION_MODE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_FTP_TRANSFER_MODE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="E_SAME_DIRECTORY_ONLY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p>
- A {@link FileSystem} backed by an FTP client provided by <a
- href="http://commons.apache.org/net/">Apache Commons Net</a>.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ftp.FTPFileSystem -->
- </package>
- <package name="org.apache.hadoop.fs.http">
- </package>
- <package name="org.apache.hadoop.fs.permission">
- <!-- start class org.apache.hadoop.fs.permission.AccessControlException -->
- <class name="AccessControlException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link org.apache.hadoop.security.AccessControlException}
- instead.">
- <constructor name="AccessControlException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor is needed for unwrapping from
- {@link org.apache.hadoop.ipc.RemoteException}.]]>
- </doc>
- </constructor>
- <constructor name="AccessControlException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs an {@link AccessControlException}
- with the specified detail message.
- @param s the detail message.]]>
- </doc>
- </constructor>
- <constructor name="AccessControlException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a new exception with the specified cause and a detail
- message of <tt>(cause==null ? null : cause.toString())</tt> (which
- typically contains the class and detail message of <tt>cause</tt>).
- @param cause the cause (which is saved for later retrieval by the
- {@link #getCause()} method). (A <tt>null</tt> value is
- permitted, and indicates that the cause is nonexistent or
- unknown.)]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[An exception class for access control related issues.
- @deprecated Use {@link org.apache.hadoop.security.AccessControlException}
- instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.AccessControlException -->
- <!-- start class org.apache.hadoop.fs.permission.AclEntry -->
- <class name="AclEntry" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getType" return="org.apache.hadoop.fs.permission.AclEntryType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the ACL entry type.
- @return AclEntryType ACL entry type]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the optional ACL entry name.
- @return String ACL entry name, or null if undefined]]>
- </doc>
- </method>
- <method name="getPermission" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the set of permissions in the ACL entry.
- @return FsAction set of permissions in the ACL entry]]>
- </doc>
- </method>
- <method name="getScope" return="org.apache.hadoop.fs.permission.AclEntryScope"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the scope of the ACL entry.
- @return AclEntryScope scope of the ACL entry]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toStringStable" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a string representation guaranteed to be stable across versions to
- satisfy backward compatibility requirements, such as for shell command
- output or serialization. The format of this string representation matches
- what is expected by the {@link #parseAclSpec(String, boolean)} and
- {@link #parseAclEntry(String, boolean)} methods.
- @return stable, backward compatible string representation]]>
- </doc>
- </method>
- <method name="parseAclSpec" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="aclSpec" type="java.lang.String"/>
- <param name="includePermission" type="boolean"/>
- <doc>
- <![CDATA[Parses a string representation of an ACL spec into a list of AclEntry
- objects. Example: "user::rwx,user:foo:rw-,group::r--,other::---"
- The expected format of ACL entries in the string parameter is the same
- format produced by the {@link #toStringStable()} method.
-
- @param aclSpec
- String representation of an ACL spec.
- @param includePermission
- for setAcl operations this will be true. i.e. AclSpec should
- include permissions.<br>
- But for removeAcl operation it will be false. i.e. AclSpec should
- not contain permissions.<br>
- Example: "user:foo,group:bar"
- @return Returns list of {@link AclEntry} parsed]]>
- </doc>
- </method>
- <method name="parseAclEntry" return="org.apache.hadoop.fs.permission.AclEntry"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="aclStr" type="java.lang.String"/>
- <param name="includePermission" type="boolean"/>
- <doc>
- <![CDATA[Parses a string representation of an ACL into a AclEntry object.<br>
- The expected format of ACL entries in the string parameter is the same
- format produced by the {@link #toStringStable()} method.
-
- @param aclStr
- String representation of an ACL.<br>
- Example: "user:foo:rw-"
- @param includePermission
- for setAcl operations this will be true. i.e. Acl should include
- permissions.<br>
- But for removeAcl operation it will be false. i.e. Acl should not
- contain permissions.<br>
- Example: "user:foo,group:bar,mask::"
- @return Returns an {@link AclEntry} object]]>
- </doc>
- </method>
- <method name="aclSpecToString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="aclSpec" type="java.util.List"/>
- <doc>
- <![CDATA[Convert a List of AclEntries into a string - the reverse of parseAclSpec.
- @param aclSpec List of AclEntries to convert
- @return String representation of aclSpec]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Defines a single entry in an ACL. An ACL entry has a type (user, group,
- mask, or other), an optional name (referring to a specific user or group), a
- set of permissions (any combination of read, write and execute), and a scope
- (access or default). AclEntry instances are immutable. Use a {@link Builder}
- to create a new instance.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.AclEntry -->
- <!-- start class org.apache.hadoop.fs.permission.AclEntryScope -->
- <class name="AclEntryScope" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.permission.AclEntryScope[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.permission.AclEntryScope"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Specifies the scope or intended usage of an ACL entry.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.AclEntryScope -->
- <!-- start class org.apache.hadoop.fs.permission.AclEntryType -->
- <class name="AclEntryType" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.permission.AclEntryType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.permission.AclEntryType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toStringStable" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a string representation guaranteed to be stable across versions to
- satisfy backward compatibility requirements, such as for shell command
- output or serialization.
- @return stable, backward compatible string representation]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Specifies the type of an ACL entry.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.AclEntryType -->
- <!-- start class org.apache.hadoop.fs.permission.AclStatus -->
- <class name="AclStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getOwner" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the file owner.
- @return String file owner]]>
- </doc>
- </method>
- <method name="getGroup" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the file group.
- @return String file group]]>
- </doc>
- </method>
- <method name="isStickyBit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the sticky bit.
-
- @return boolean sticky bit]]>
- </doc>
- </method>
- <method name="getEntries" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the list of all ACL entries, ordered by their natural ordering.
- @return List<AclEntry> unmodifiable ordered list of all ACL entries]]>
- </doc>
- </method>
- <method name="getPermission" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the permission set for the path
- @return {@link FsPermission} for the path]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getEffectivePermission" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entry" type="org.apache.hadoop.fs.permission.AclEntry"/>
- <doc>
- <![CDATA[Get the effective permission for the AclEntry
- @param entry AclEntry to get the effective action]]>
- </doc>
- </method>
- <method name="getEffectivePermission" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entry" type="org.apache.hadoop.fs.permission.AclEntry"/>
- <param name="permArg" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[Get the effective permission for the AclEntry. <br>
- Recommended to use this API ONLY if client communicates with the old
- NameNode, needs to pass the Permission for the path to get effective
- permission, else use {@link AclStatus#getEffectivePermission(AclEntry)}.
- @param entry AclEntry to get the effective action
- @param permArg Permission for the path. However if the client is NOT
- communicating with old namenode, then this argument will not have
- any preference.
- @return Returns the effective permission for the entry.
- @throws IllegalArgumentException If the client communicating with old
- namenode and permission is not passed as an argument.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An AclStatus contains the ACL information of a specific file. AclStatus
- instances are immutable. Use a {@link Builder} to create a new instance.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.AclStatus -->
- <!-- start class org.apache.hadoop.fs.permission.FsAction -->
- <class name="FsAction" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.permission.FsAction[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="implies" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.fs.permission.FsAction"/>
- <doc>
- <![CDATA[Return true if this action implies that action.
- @param that]]>
- </doc>
- </method>
- <method name="and" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.fs.permission.FsAction"/>
- <doc>
- <![CDATA[AND operation.]]>
- </doc>
- </method>
- <method name="or" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.fs.permission.FsAction"/>
- <doc>
- <![CDATA[OR operation.]]>
- </doc>
- </method>
- <method name="not" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[NOT operation.]]>
- </doc>
- </method>
- <method name="getFsAction" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="permission" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the FsAction enum for String representation of permissions
-
- @param permission
- 3-character string representation of permission. ex: rwx
- @return Returns FsAction enum if the corresponding FsAction exists for permission.
- Otherwise returns null]]>
- </doc>
- </method>
- <field name="SYMBOL" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Symbolic representation]]>
- </doc>
- </field>
- <doc>
- <![CDATA[File system actions, e.g. read, write, etc.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.FsAction -->
- <!-- start class org.apache.hadoop.fs.permission.FsPermission -->
- <class name="FsPermission" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="FsPermission" type="org.apache.hadoop.fs.permission.FsAction, org.apache.hadoop.fs.permission.FsAction, org.apache.hadoop.fs.permission.FsAction"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct by the given {@link FsAction}.
- @param u user action
- @param g group action
- @param o other action]]>
- </doc>
- </constructor>
- <constructor name="FsPermission" type="org.apache.hadoop.fs.permission.FsAction, org.apache.hadoop.fs.permission.FsAction, org.apache.hadoop.fs.permission.FsAction, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FsPermission" type="short"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct by the given mode.
- @param mode
- @see #toShort()]]>
- </doc>
- </constructor>
- <constructor name="FsPermission" type="org.apache.hadoop.fs.permission.FsPermission"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Copy constructor
-
- @param other other permission]]>
- </doc>
- </constructor>
- <constructor name="FsPermission" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct by given mode, either in octal or symbolic format.
- @param mode mode as a string, either in octal or symbolic format
- @throws IllegalArgumentException if <code>mode</code> is invalid]]>
- </doc>
- </constructor>
- <method name="createImmutable" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="permission" type="short"/>
- <doc>
- <![CDATA[Create an immutable {@link FsPermission} object.]]>
- </doc>
- </method>
- <method name="getUserAction" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return user {@link FsAction}.]]>
- </doc>
- </method>
- <method name="getGroupAction" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return group {@link FsAction}.]]>
- </doc>
- </method>
- <method name="getOtherAction" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return other {@link FsAction}.]]>
- </doc>
- </method>
- <method name="fromShort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="short"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create and initialize a {@link FsPermission} from {@link DataInput}.]]>
- </doc>
- </method>
- <method name="toShort" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Encode the object to a short.]]>
- </doc>
- </method>
- <method name="toExtendedShort" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Encodes the object to a short. Unlike {@link #toShort()}, this method may
- return values outside the fixed range 00000 - 01777 if extended features
- are encoded into this permission, such as the ACL bit.
- @return short extended short representation of this permission]]>
- </doc>
- </method>
- <method name="toOctal" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the FsPermission in an octal format.
- @return short Unlike {@link #toShort()} which provides a binary
- representation, this method returns the standard octal style permission.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="applyUMask" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="umask" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <doc>
- <![CDATA[Apply a umask to this permission and return a new one.
- The umask is used by create, mkdir, and other Hadoop filesystem operations.
- The mode argument for these operations is modified by removing the bits
- which are set in the umask. Thus, the umask limits the permissions which
- newly created files and directories get.
- @param umask The umask to use
-
- @return The effective permission]]>
- </doc>
- </method>
- <method name="getUMask" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the user file creation mask (umask)
-
- {@code UMASK_LABEL} config param has umask value that is either symbolic
- or octal.
-
- Symbolic umask is applied relative to file mode creation mask;
- the permission op characters '+' clears the corresponding bit in the mask,
- '-' sets bits in the mask.
-
- Octal umask, the specified bits are set in the file mode creation mask.
-
- {@code DEPRECATED_UMASK_LABEL} config param has umask value set to decimal.]]>
- </doc>
- </method>
- <method name="getStickyBit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAclBit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if there is also an ACL (access control list).
- @return boolean true if there is also an ACL (access control list).]]>
- </doc>
- </method>
- <method name="getEncryptedBit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the file is encrypted or directory is in an encryption zone]]>
- </doc>
- </method>
- <method name="setUMask"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="umask" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <doc>
- <![CDATA[Set the user file creation mask (umask)]]>
- </doc>
- </method>
- <method name="getDefault" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default permission for directory and symlink.
- In previous versions, this default permission was also used to
- create files, so files created end up with ugo+x permission.
- See HADOOP-9155 for detail.
- Two new methods are added to solve this, please use
- {@link FsPermission#getDirDefault()} for directory, and use
- {@link FsPermission#getFileDefault()} for file.
- This method is kept for compatibility.]]>
- </doc>
- </method>
- <method name="getDirDefault" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default permission for directory.]]>
- </doc>
- </method>
- <method name="getFileDefault" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default permission for file.]]>
- </doc>
- </method>
- <method name="getCachePoolDefault" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default permission for cache pools.]]>
- </doc>
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="unixSymbolicPermission" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a FsPermission from a Unix symbolic permission string
- @param unixSymbolicPermission e.g. "-rw-rw-rw-"]]>
- </doc>
- </method>
- <field name="MAX_PERMISSION_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Maximum acceptable length of a permission string to parse]]>
- </doc>
- </field>
- <field name="DEPRECATED_UMASK_LABEL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[umask property label deprecated key and code in getUMask method
- to accommodate it may be removed in version .23]]>
- </doc>
- </field>
- <field name="UMASK_LABEL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_UMASK" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A class for file/directory permissions.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.FsPermission -->
- </package>
- <package name="org.apache.hadoop.fs.sftp">
- </package>
- <package name="org.apache.hadoop.fs.shell.find">
- </package>
- <package name="org.apache.hadoop.fs.viewfs">
- <!-- start class org.apache.hadoop.fs.viewfs.NotInMountpointException -->
- <class name="NotInMountpointException" extends="java.lang.UnsupportedOperationException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NotInMountpointException" type="org.apache.hadoop.fs.Path, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="NotInMountpointException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[NotInMountpointException extends the UnsupportedOperationException.
- Exception class used in cases where the given path is not mounted
- through viewfs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.viewfs.NotInMountpointException -->
- <!-- start class org.apache.hadoop.fs.viewfs.ViewFileSystem -->
- <class name="ViewFileSystem" extends="org.apache.hadoop.fs.FileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ViewFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This is the constructor with the signature needed by
- {@link FileSystem#createFileSystem(URI, Configuration)}
-
- After this constructor is called initialize() is called.
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="ViewFileSystem" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convenience Constructor for apps to call directly
- @param conf
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="getScheme" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the protocol scheme for the FileSystem.
- <p/>
- @return <code>viewfs</code>]]>
- </doc>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theUri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called after a new FileSystem instance is constructed.
- @param theUri a uri whose authority section names the host, port, etc. for
- this FileSystem
- @param conf the configuration]]>
- </doc>
- </method>
- <method name="getTrashCanLocation" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="resolvePath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="new_dir" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="flags" type="java.util.EnumSet"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="start" type="long"/>
- <param name="len" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="access"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="mode" type="org.apache.hadoop.fs.permission.FsAction"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="truncate" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="newLength" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setTimes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="mtime" type="long"/>
- <param name="atime" type="long"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="modifyAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeDefaultAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getAclStatus" return="org.apache.hadoop.fs.permission.AclStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="byte[]"/>
- <param name="flag" type="java.util.EnumSet"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getXAttr" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="names" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listXAttrs" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setVerifyChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- </method>
- <method name="getDefaultBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDefaultReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getDefaultBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getDefaultReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getContentSummary" return="org.apache.hadoop.fs.ContentSummary"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getQuotaUsage" return="org.apache.hadoop.fs.QuotaUsage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setWriteChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writeChecksum" type="boolean"/>
- </method>
- <method name="getChildFileSystems" return="org.apache.hadoop.fs.FileSystem[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMountPoints" return="org.apache.hadoop.fs.viewfs.ViewFileSystem.MountPoint[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createSnapshot" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="renameSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotOldName" type="java.lang.String"/>
- <param name="snapshotNewName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="deleteSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[ViewFileSystem (extends the FileSystem interface) implements a client-side
- mount table. Its spec and implementation is identical to {@link ViewFs}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.viewfs.ViewFileSystem -->
- <!-- start class org.apache.hadoop.fs.viewfs.ViewFs -->
- <class name="ViewFs" extends="org.apache.hadoop.fs.AbstractFileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ViewFs" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
- </constructor>
- <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getUriDefaultPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="resolvePath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createInternal" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="flag" type="java.util.EnumSet"/>
- <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
- <param name="createParent" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="start" type="long"/>
- <param name="len" type="long"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="access"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="mode" type="org.apache.hadoop.fs.permission.FsAction"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listStatusIterator" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkdir"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="createParent" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="truncate" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="newLength" type="long"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="renameInternal"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- </method>
- <method name="renameInternal"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="supportsSymlinks" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createSymlink"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="org.apache.hadoop.fs.Path"/>
- <param name="link" type="org.apache.hadoop.fs.Path"/>
- <param name="createParent" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- </method>
- <method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setTimes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="mtime" type="long"/>
- <param name="atime" type="long"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setVerifyChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getMountPoints" return="org.apache.hadoop.fs.viewfs.ViewFs.MountPoint[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDelegationTokens" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="isValidName" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="java.lang.String"/>
- </method>
- <method name="modifyAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeAclEntries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeDefaultAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="aclSpec" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getAclStatus" return="org.apache.hadoop.fs.permission.AclStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="byte[]"/>
- <param name="flag" type="java.util.EnumSet"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getXAttr" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getXAttrs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="names" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listXAttrs" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="removeXAttr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSnapshot" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="renameSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotOldName" type="java.lang.String"/>
- <param name="snapshotNewName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="deleteSnapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="snapshotName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setStoragePolicy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="policyName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="unsetStoragePolicy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getStoragePolicy" return="org.apache.hadoop.fs.BlockStoragePolicySpi"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Retrieve the storage policy for a given file or directory.
- @param src file or directory path.
- @return storage policy for give file.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[ViewFs (extends the AbstractFileSystem interface) implements a client-side
- mount table. The viewFs file system is implemented completely in memory on
- the client side. The client-side mount table allows a client to provide a
- customized view of a file system namespace that is composed from
- one or more individual file systems (a localFs or Hdfs, S3fs, etc).
- For example one could have a mount table that provides links such as
- <ul>
- <li> /user -> hdfs://nnContainingUserDir/user
- <li> /project/foo -> hdfs://nnProject1/projects/foo
- <li> /project/bar -> hdfs://nnProject2/projects/bar
- <li> /tmp -> hdfs://nnTmp/privateTmpForUserXXX
- </ul>
-
- ViewFs is specified with the following URI: <b>viewfs:///</b>
- <p>
- To use viewfs one would typically set the default file system in the
- config (i.e. fs.defaultFS < = viewfs:///) along with the
- mount table config variables as described below.
-
- <p>
- <b> ** Config variables to specify the mount table entries ** </b>
- <p>
-
- The file system is initialized from the standard Hadoop config through
- config variables.
- See {@link FsConstants} for URI and Scheme constants;
- See {@link Constants} for config var constants;
- see {@link ConfigUtil} for convenient lib.
-
- <p>
- All the mount table config entries for view fs are prefixed by
- <b>fs.viewfs.mounttable.</b>
- For example the above example can be specified with the following
- config variables:
- <ul>
- <li> fs.viewfs.mounttable.default.link./user=
- hdfs://nnContainingUserDir/user
- <li> fs.viewfs.mounttable.default.link./project/foo=
- hdfs://nnProject1/projects/foo
- <li> fs.viewfs.mounttable.default.link./project/bar=
- hdfs://nnProject2/projects/bar
- <li> fs.viewfs.mounttable.default.link./tmp=
- hdfs://nnTmp/privateTmpForUserXXX
- </ul>
-
- The default mount table (when no authority is specified) is
- from config variables prefixed by <b>fs.viewFs.mounttable.default </b>
- The authority component of a URI can be used to specify a different mount
- table. For example,
- <ul>
- <li> viewfs://sanjayMountable/
- </ul>
- is initialized from fs.viewFs.mounttable.sanjayMountable.* config variables.
-
- <p>
- <b> **** Merge Mounts **** </b>(NOTE: merge mounts are not implemented yet.)
- <p>
-
- One can also use "MergeMounts" to merge several directories (this is
- sometimes called union-mounts or junction-mounts in the literature.
- For example of the home directories are stored on say two file systems
- (because they do not fit on one) then one could specify a mount
- entry such as following merges two dirs:
- <ul>
- <li> /user -> hdfs://nnUser1/user,hdfs://nnUser2/user
- </ul>
- Such a mergeLink can be specified with the following config var where ","
- is used as the separator for each of links to be merged:
- <ul>
- <li> fs.viewfs.mounttable.default.linkMerge./user=
- hdfs://nnUser1/user,hdfs://nnUser1/user
- </ul>
- A special case of the merge mount is where mount table's root is merged
- with the root (slash) of another file system:
- <ul>
- <li> fs.viewfs.mounttable.default.linkMergeSlash=hdfs://nn99/
- </ul>
- In this cases the root of the mount table is merged with the root of
- <b>hdfs://nn99/ </b>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.viewfs.ViewFs -->
- </package>
- <package name="org.apache.hadoop.ha">
- <!-- start class org.apache.hadoop.ha.BadFencingConfigurationException -->
- <class name="BadFencingConfigurationException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BadFencingConfigurationException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="BadFencingConfigurationException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Indicates that the operator has specified an invalid configuration
- for fencing methods.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ha.BadFencingConfigurationException -->
- <!-- start class org.apache.hadoop.ha.FailoverFailedException -->
- <class name="FailoverFailedException" extends="java.lang.Exception"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FailoverFailedException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FailoverFailedException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Exception thrown to indicate service failover has failed.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ha.FailoverFailedException -->
- <!-- start interface org.apache.hadoop.ha.FenceMethod -->
- <interface name="FenceMethod" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="checkArgs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String"/>
- <exception name="BadFencingConfigurationException" type="org.apache.hadoop.ha.BadFencingConfigurationException"/>
- <doc>
- <![CDATA[Verify that the given fencing method's arguments are valid.
- @param args the arguments provided in the configuration. This may
- be null if the operator did not configure any arguments.
- @throws BadFencingConfigurationException if the arguments are invalid]]>
- </doc>
- </method>
- <method name="tryFence" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="org.apache.hadoop.ha.HAServiceTarget"/>
- <param name="args" type="java.lang.String"/>
- <exception name="BadFencingConfigurationException" type="org.apache.hadoop.ha.BadFencingConfigurationException"/>
- <doc>
- <![CDATA[Attempt to fence the target node.
- @param target the address (host:ipcport) of the service to fence
- @param args the configured arguments, which were checked at startup by
- {@link #checkArgs(String)}
- @return true if fencing was successful, false if unsuccessful or
- indeterminate
- @throws BadFencingConfigurationException if the configuration was
- determined to be invalid only at runtime]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A fencing method is a method by which one node can forcibly prevent
- another node from making continued progress. This might be implemented
- by killing a process on the other node, by denying the other node's
- access to shared storage, or by accessing a PDU to cut the other node's
- power.
- <p>
- Since these methods are often vendor- or device-specific, operators
- may implement this interface in order to achieve fencing.
- <p>
- Fencing is configured by the operator as an ordered list of methods to
- attempt. Each method will be tried in turn, and the next in the list
- will only be attempted if the previous one fails. See {@link NodeFencer}
- for more information.
- <p>
- If an implementation also implements {@link Configurable} then its
- <code>setConf</code> method will be called upon instantiation.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.ha.FenceMethod -->
- <!-- start interface org.apache.hadoop.ha.HAServiceProtocol -->
- <interface name="HAServiceProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="monitorHealth"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="HealthCheckFailedException" type="org.apache.hadoop.ha.HealthCheckFailedException"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Monitor the health of service. This periodically called by the HA
- frameworks to monitor the health of the service.
-
- Service is expected to perform checks to ensure it is functional.
- If the service is not healthy due to failure or partial failure,
- it is expected to throw {@link HealthCheckFailedException}.
- The definition of service not healthy is left to the service.
-
- Note that when health check of an Active service fails,
- failover to standby may be done.
-
- @throws HealthCheckFailedException
- if the health check of a service fails.
- @throws AccessControlException
- if access is denied.
- @throws IOException
- if other errors happen]]>
- </doc>
- </method>
- <method name="transitionToActive"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reqInfo" type="org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo"/>
- <exception name="ServiceFailedException" type="org.apache.hadoop.ha.ServiceFailedException"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Request service to transition to active state. No operation, if the
- service is already in active state.
-
- @throws ServiceFailedException
- if transition from standby to active fails.
- @throws AccessControlException
- if access is denied.
- @throws IOException
- if other errors happen]]>
- </doc>
- </method>
- <method name="transitionToStandby"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reqInfo" type="org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo"/>
- <exception name="ServiceFailedException" type="org.apache.hadoop.ha.ServiceFailedException"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Request service to transition to standby state. No operation, if the
- service is already in standby state.
-
- @throws ServiceFailedException
- if transition from active to standby fails.
- @throws AccessControlException
- if access is denied.
- @throws IOException
- if other errors happen]]>
- </doc>
- </method>
- <method name="transitionToObserver"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reqInfo" type="org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo"/>
- <exception name="ServiceFailedException" type="org.apache.hadoop.ha.ServiceFailedException"/>
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Request service to transition to observer state. No operation, if the
- service is already in observer state.
- @throws ServiceFailedException
- if transition from standby to observer fails.
- @throws AccessControlException
- if access is denied.
- @throws IOException
- if other errors happen]]>
- </doc>
- </method>
- <method name="getServiceStatus" return="org.apache.hadoop.ha.HAServiceStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the current status of the service. The status indicates
- the current <em>state</em> (e.g ACTIVE/STANDBY) as well as
- some additional information.
- @throws AccessControlException
- if access is denied.
- @throws IOException
- if other errors happen
- @see HAServiceStatus]]>
- </doc>
- </method>
- <field name="versionID" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Initial version of the protocol]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Protocol interface that provides High Availability related primitives to
- monitor and fail-over the service.
-
- This interface could be used by HA frameworks to manage the service.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.ha.HAServiceProtocol -->
- <!-- start class org.apache.hadoop.ha.HAServiceProtocolHelper -->
- <class name="HAServiceProtocolHelper" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HAServiceProtocolHelper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="monitorHealth"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="svc" type="org.apache.hadoop.ha.HAServiceProtocol"/>
- <param name="reqInfo" type="org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="transitionToActive"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="svc" type="org.apache.hadoop.ha.HAServiceProtocol"/>
- <param name="reqInfo" type="org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="transitionToStandby"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="svc" type="org.apache.hadoop.ha.HAServiceProtocol"/>
- <param name="reqInfo" type="org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="transitionToObserver"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="svc" type="org.apache.hadoop.ha.HAServiceProtocol"/>
- <param name="reqInfo" type="org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Helper for making {@link HAServiceProtocol} RPC calls. This helper
- unwraps the {@link RemoteException} to specific exceptions.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ha.HAServiceProtocolHelper -->
- <!-- start class org.apache.hadoop.ha.HAServiceTarget -->
- <class name="HAServiceTarget" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HAServiceTarget"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAddress" return="java.net.InetSocketAddress"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the IPC address of the target node.]]>
- </doc>
- </method>
- <method name="getHealthMonitorAddress" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns an optional separate RPC server address for health checks at the
- target node. If defined, then this address is used by the health monitor
- for the {@link HAServiceProtocol#monitorHealth()} and
- {@link HAServiceProtocol#getServiceStatus()} calls. This can be useful for
- separating out these calls onto separate RPC handlers to protect against
- resource exhaustion in the main RPC handler pool. If null (which is the
- default implementation), then all RPC calls go to the address defined by
- {@link #getAddress()}.
- @return IPC address of the lifeline RPC server on the target node, or null
- if no lifeline RPC server is used]]>
- </doc>
- </method>
- <method name="getZKFCAddress" return="java.net.InetSocketAddress"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the IPC address of the ZKFC on the target node]]>
- </doc>
- </method>
- <method name="getFencer" return="org.apache.hadoop.ha.NodeFencer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return a Fencer implementation configured for this target node]]>
- </doc>
- </method>
- <method name="checkFencingConfigured"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="BadFencingConfigurationException" type="org.apache.hadoop.ha.BadFencingConfigurationException"/>
- <doc>
- <![CDATA[@throws BadFencingConfigurationException if the fencing configuration
- appears to be invalid. This is divorced from the above
- {@link #getFencer()} method so that the configuration can be checked
- during the pre-flight phase of failover.]]>
- </doc>
- </method>
- <method name="getProxy" return="org.apache.hadoop.ha.HAServiceProtocol"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="timeoutMs" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return a proxy to connect to the target HA Service.]]>
- </doc>
- </method>
- <method name="getHealthMonitorProxy" return="org.apache.hadoop.ha.HAServiceProtocol"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="timeoutMs" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a proxy to connect to the target HA service for health monitoring.
- If {@link #getHealthMonitorAddress()} is implemented to return a non-null
- address, then this proxy will connect to that address. Otherwise, the
- returned proxy defaults to using {@link #getAddress()}, which means this
- method's behavior is identical to {@link #getProxy(Configuration, int)}.
- @param conf Configuration
- @param timeoutMs timeout in milliseconds
- @return a proxy to connect to the target HA service for health monitoring
- @throws IOException if there is an error]]>
- </doc>
- </method>
- <method name="getZKFCProxy" return="org.apache.hadoop.ha.ZKFCProtocol"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="timeoutMs" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return a proxy to the ZKFC which is associated with this HA service.]]>
- </doc>
- </method>
- <method name="getFencingParameters" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="addFencingParameters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="ret" type="java.util.Map"/>
- <doc>
- <![CDATA[Hook to allow subclasses to add any parameters they would like to
- expose to fencing implementations/scripts. Fencing methods are free
- to use this map as they see fit -- notably, the shell script
- implementation takes each entry, prepends 'target_', substitutes
- '_' for '.', and adds it to the environment of the script.
- Subclass implementations should be sure to delegate to the superclass
- implementation as well as adding their own keys.
- @param ret map which can be mutated to pass parameters to the fencer]]>
- </doc>
- </method>
- <method name="isAutoFailoverEnabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if auto failover should be considered enabled]]>
- </doc>
- </method>
- <method name="supportObserver" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if this target supports the Observer state, false otherwise.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Represents a target of the client side HA administration commands.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ha.HAServiceTarget -->
- <!-- start class org.apache.hadoop.ha.HealthCheckFailedException -->
- <class name="HealthCheckFailedException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HealthCheckFailedException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="HealthCheckFailedException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Exception thrown to indicate that health check of a service failed.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ha.HealthCheckFailedException -->
- <!-- start class org.apache.hadoop.ha.ServiceFailedException -->
- <class name="ServiceFailedException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ServiceFailedException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ServiceFailedException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Exception thrown to indicate that an operation performed
- to modify the state of a service or application failed.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ha.ServiceFailedException -->
- </package>
- <package name="org.apache.hadoop.ha.protocolPB">
- <!-- start interface org.apache.hadoop.ha.protocolPB.HAServiceProtocolPB -->
- <interface name="HAServiceProtocolPB" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.ha.proto.HAServiceProtocolProtos.HAServiceProtocolService.BlockingInterface"/>
- <implements name="org.apache.hadoop.ipc.VersionedProtocol"/>
- </interface>
- <!-- end interface org.apache.hadoop.ha.protocolPB.HAServiceProtocolPB -->
- <!-- start interface org.apache.hadoop.ha.protocolPB.ZKFCProtocolPB -->
- <interface name="ZKFCProtocolPB" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.ha.proto.ZKFCProtocolProtos.ZKFCProtocolService.BlockingInterface"/>
- <implements name="org.apache.hadoop.ipc.VersionedProtocol"/>
- </interface>
- <!-- end interface org.apache.hadoop.ha.protocolPB.ZKFCProtocolPB -->
- </package>
- <package name="org.apache.hadoop.http.lib">
- <doc>
- <![CDATA[This package provides user-selectable (via configuration) classes that add
- functionality to the web UI. They are configured as a list of classes in the
- configuration parameter <b>hadoop.http.filter.initializers</b>.
- <ul>
- <li> <b>StaticUserWebFilter</b> - An authorization plugin that makes all
- users a static configured user.
- </ul>]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.io">
- <!-- start class org.apache.hadoop.io.AbstractMapWritable -->
- <class name="AbstractMapWritable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="AbstractMapWritable"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[constructor.]]>
- </doc>
- </constructor>
- <method name="addToMap"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="clazz" type="java.lang.Class"/>
- <doc>
- <![CDATA[Add a Class to the maps if it is not already present.]]>
- </doc>
- </method>
- <method name="getClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="id" type="byte"/>
- <doc>
- <![CDATA[@return the Class class for the specified id]]>
- </doc>
- </method>
- <method name="getId" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="clazz" type="java.lang.Class"/>
- <doc>
- <![CDATA[@return the id for the specified Class]]>
- </doc>
- </method>
- <method name="copy"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.io.Writable"/>
- <doc>
- <![CDATA[Used by child copy constructors.]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the conf]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[@param conf the conf to set]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Abstract base class for MapWritable and SortedMapWritable
-
- Unlike org.apache.nutch.crawl.MapWritable, this class allows creation of
- MapWritable<Writable, MapWritable> so the CLASS_TO_ID and ID_TO_CLASS
- maps travel with the class instead of being static.
-
- Class ids range from 1 to 127 so there can be at most 127 distinct classes
- in any specific map instance.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.AbstractMapWritable -->
- <!-- start class org.apache.hadoop.io.ArrayFile -->
- <class name="ArrayFile" extends="org.apache.hadoop.io.MapFile"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ArrayFile"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A dense file-based mapping from integers to values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ArrayFile -->
- <!-- start class org.apache.hadoop.io.ArrayPrimitiveWritable -->
- <class name="ArrayPrimitiveWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="ArrayPrimitiveWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct an empty instance, for use during Writable read]]>
- </doc>
- </constructor>
- <constructor name="ArrayPrimitiveWritable" type="java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct an instance of known type but no value yet
- for use with type-specific wrapper classes]]>
- </doc>
- </constructor>
- <constructor name="ArrayPrimitiveWritable" type="java.lang.Object"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Wrap an existing array of primitives
- @param value - array of primitives]]>
- </doc>
- </constructor>
- <method name="get" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the original array.
- Client must cast it back to type componentType[]
- (or may use type-specific wrapper classes).
- @return - original array as Object]]>
- </doc>
- </method>
- <method name="getComponentType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDeclaredComponentType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isDeclaredComponentType" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="componentType" type="java.lang.Class"/>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.Object"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This is a wrapper class. It wraps a Writable implementation around
- an array of primitives (e.g., int[], long[], etc.), with optimized
- wire format, and without creating new objects per element.
-
- This is a wrapper class only; it does not make a copy of the
- underlying array.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ArrayPrimitiveWritable -->
- <!-- start class org.apache.hadoop.io.ArrayWritable -->
- <class name="ArrayWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="ArrayWritable" type="java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ArrayWritable" type="java.lang.Class, org.apache.hadoop.io.Writable[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ArrayWritable" type="java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toStrings" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toArray" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="values" type="org.apache.hadoop.io.Writable[]"/>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A Writable for arrays containing instances of a class. The elements of this
- writable must all be instances of the same class. If this writable will be
- the input for a Reducer, you will need to create a subclass that sets the
- value to be of the proper type.
- For example:
- <code>
- public class IntArrayWritable extends ArrayWritable {
- public IntArrayWritable() {
- super(IntWritable.class);
- }
- }
- </code>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ArrayWritable -->
- <!-- start class org.apache.hadoop.io.BinaryComparable -->
- <class name="BinaryComparable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="BinaryComparable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getLength" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return n st bytes 0..n-1 from {#getBytes()} are valid.]]>
- </doc>
- </method>
- <method name="getBytes" return="byte[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return representative byte array for this instance.]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.io.BinaryComparable"/>
- <doc>
- <![CDATA[Compare bytes from {#getBytes()}.
- @see org.apache.hadoop.io.WritableComparator#compareBytes(byte[],int,int,byte[],int,int)]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Compare bytes from {#getBytes()} to those provided.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- <doc>
- <![CDATA[Return true if bytes from {#getBytes()} match.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a hash of the bytes returned from {#getBytes()}.
- @see org.apache.hadoop.io.WritableComparator#hashBytes(byte[],int)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface supported by {@link org.apache.hadoop.io.WritableComparable}
- types supporting ordering/permutation by a representative set of bytes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.BinaryComparable -->
- <!-- start class org.apache.hadoop.io.BloomMapFile -->
- <class name="BloomMapFile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BloomMapFile"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="delete"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="BLOOM_FILE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HASH_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class extends {@link MapFile} and provides very much the same
- functionality. However, it uses dynamic Bloom filters to provide
- quick membership test for keys, and it offers a fast version of
- {@link Reader#get(WritableComparable, Writable)} operation, especially in
- case of sparsely populated MapFile-s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.BloomMapFile -->
- <!-- start class org.apache.hadoop.io.BooleanWritable -->
- <class name="BooleanWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="BooleanWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="BooleanWritable" type="boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Set the value of the BooleanWritable]]>
- </doc>
- </method>
- <method name="get" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the value of the BooleanWritable]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.io.BooleanWritable"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for booleans.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.BooleanWritable -->
- <!-- start interface org.apache.hadoop.io.ByteBufferPool -->
- <interface name="ByteBufferPool" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getBuffer" return="java.nio.ByteBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="direct" type="boolean"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Get a new direct ByteBuffer. The pool can provide this from
- removing a buffer from its internal cache, or by allocating a
- new buffer.
- @param direct Whether the buffer should be direct.
- @param length The minimum length the buffer will have.
- @return A new ByteBuffer. This ByteBuffer must be direct.
- Its capacity can be less than what was requested, but
- must be at least 1 byte.]]>
- </doc>
- </method>
- <method name="putBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buffer" type="java.nio.ByteBuffer"/>
- <doc>
- <![CDATA[Release a buffer back to the pool.
- The pool may choose to put this buffer into its cache.
- @param buffer a direct bytebuffer]]>
- </doc>
- </method>
- </interface>
- <!-- end interface org.apache.hadoop.io.ByteBufferPool -->
- <!-- start class org.apache.hadoop.io.BytesWritable -->
- <class name="BytesWritable" extends="org.apache.hadoop.io.BinaryComparable"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="BytesWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a zero-size sequence.]]>
- </doc>
- </constructor>
- <constructor name="BytesWritable" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a BytesWritable using the byte array as the initial value.
- @param bytes This array becomes the backing storage for the object.]]>
- </doc>
- </constructor>
- <constructor name="BytesWritable" type="byte[], int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a BytesWritable using the byte array as the initial value
- and length as the length. Use this constructor if the array is larger
- than the value it represents.
- @param bytes This array becomes the backing storage for the object.
- @param length The number of bytes to use from array.]]>
- </doc>
- </constructor>
- <method name="copyBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a copy of the bytes that is exactly the length of the data.
- See {@link #getBytes()} for faster access to the underlying array.]]>
- </doc>
- </method>
- <method name="getBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the data backing the BytesWritable. Please use {@link #copyBytes()}
- if you need the returned array to be precisely the length of the data.
- @return The data is only valid between 0 and getLength() - 1.]]>
- </doc>
- </method>
- <method name="get" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #getBytes()} instead.">
- <doc>
- <![CDATA[Get the data from the BytesWritable.
- @deprecated Use {@link #getBytes()} instead.]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current size of the buffer.]]>
- </doc>
- </method>
- <method name="getSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #getLength()} instead.">
- <doc>
- <![CDATA[Get the current size of the buffer.
- @deprecated Use {@link #getLength()} instead.]]>
- </doc>
- </method>
- <method name="setSize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="size" type="int"/>
- <doc>
- <![CDATA[Change the size of the buffer. The values in the old range are preserved
- and any new values are undefined. The capacity is changed if it is
- necessary.
- @param size The new number of bytes]]>
- </doc>
- </method>
- <method name="getCapacity" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the capacity, which is the maximum size that could handled without
- resizing the backing storage.
- @return The number of bytes]]>
- </doc>
- </method>
- <method name="setCapacity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="new_cap" type="int"/>
- <doc>
- <![CDATA[Change the capacity of the backing storage.
- The data is preserved.
- @param new_cap The new capacity in bytes.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newData" type="org.apache.hadoop.io.BytesWritable"/>
- <doc>
- <![CDATA[Set the BytesWritable to the contents of the given newData.
- @param newData the value to set this BytesWritable to.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newData" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Set the value to a copy of the given byte range
- @param newData the new values to copy in
- @param offset the offset in newData to start at
- @param length the number of bytes to copy]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="right_obj" type="java.lang.Object"/>
- <doc>
- <![CDATA[Are the two byte sequences equal?]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Generate the stream of bytes as hex pairs separated by ' '.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A byte sequence that is usable as a key or value.
- It is resizable and distinguishes between the size of the sequence and
- the current capacity. The hash function is the front of the md5 of the
- buffer. The sort order is the same as memcmp.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.BytesWritable -->
- <!-- start class org.apache.hadoop.io.ByteWritable -->
- <class name="ByteWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="ByteWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ByteWritable" type="byte"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="byte"/>
- <doc>
- <![CDATA[Set the value of this ByteWritable.]]>
- </doc>
- </method>
- <method name="get" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this ByteWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a ByteWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.io.ByteWritable"/>
- <doc>
- <![CDATA[Compares two ByteWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for a single byte.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ByteWritable -->
- <!-- start interface org.apache.hadoop.io.Closeable -->
- <interface name="Closeable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="use java.io.Closeable">
- <implements name="java.io.Closeable"/>
- <doc>
- <![CDATA[@deprecated use java.io.Closeable]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.Closeable -->
- <!-- start class org.apache.hadoop.io.CompressedWritable -->
- <class name="CompressedWritable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="CompressedWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="ensureInflated"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Must be called by all methods which access fields to ensure that the data
- has been uncompressed.]]>
- </doc>
- </method>
- <method name="readFieldsCompressed"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Subclasses implement this instead of {@link #readFields(DataInput)}.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeCompressed"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Subclasses implement this instead of {@link #write(DataOutput)}.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A base-class for Writables which store themselves compressed and lazily
- inflate on field access. This is useful for large objects whose fields are
- not be altered during a map or reduce operation: leaving the field data
- compressed makes copying the instance from one file to another much
- faster.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.CompressedWritable -->
- <!-- start class org.apache.hadoop.io.DataOutputOutputStream -->
- <class name="DataOutputOutputStream" extends="java.io.OutputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="constructOutputStream" return="java.io.OutputStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <doc>
- <![CDATA[Construct an OutputStream from the given DataOutput. If 'out'
- is already an OutputStream, simply returns it. Otherwise, wraps
- it in an OutputStream.
- @param out the DataOutput to wrap
- @return an OutputStream instance that outputs to 'out']]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[OutputStream implementation that wraps a DataOutput.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.DataOutputOutputStream -->
- <!-- start class org.apache.hadoop.io.DefaultStringifier -->
- <class name="DefaultStringifier" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Stringifier"/>
- <constructor name="DefaultStringifier" type="org.apache.hadoop.conf.Configuration, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="fromString" return="T"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="T"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="store"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="item" type="K"/>
- <param name="keyName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Stores the item in the configuration with the given keyName.
-
- @param <K> the class of the item
- @param conf the configuration to store
- @param item the object to be stored
- @param keyName the name of the key to use
- @throws IOException : forwards Exceptions from the underlying
- {@link Serialization} classes.]]>
- </doc>
- </method>
- <method name="load" return="K"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="keyName" type="java.lang.String"/>
- <param name="itemClass" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Restores the object from the configuration.
-
- @param <K> the class of the item
- @param conf the configuration to use
- @param keyName the name of the key to use
- @param itemClass the class of the item
- @return restored object
- @throws IOException : forwards Exceptions from the underlying
- {@link Serialization} classes.]]>
- </doc>
- </method>
- <method name="storeArray"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="items" type="K[]"/>
- <param name="keyName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Stores the array of items in the configuration with the given keyName.
-
- @param <K> the class of the item
- @param conf the configuration to use
- @param items the objects to be stored
- @param keyName the name of the key to use
- @throws IndexOutOfBoundsException if the items array is empty
- @throws IOException : forwards Exceptions from the underlying
- {@link Serialization} classes.]]>
- </doc>
- </method>
- <method name="loadArray" return="K[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="keyName" type="java.lang.String"/>
- <param name="itemClass" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Restores the array of objects from the configuration.
-
- @param <K> the class of the item
- @param conf the configuration to use
- @param keyName the name of the key to use
- @param itemClass the class of the item
- @return restored object
- @throws IOException : forwards Exceptions from the underlying
- {@link Serialization} classes.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[DefaultStringifier is the default implementation of the {@link Stringifier}
- interface which stringifies the objects using base64 encoding of the
- serialized version of the objects. The {@link Serializer} and
- {@link Deserializer} are obtained from the {@link SerializationFactory}.
- <br>
- DefaultStringifier offers convenience methods to store/load objects to/from
- the configuration.
-
- @param <T> the class of the objects to stringify]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.DefaultStringifier -->
- <!-- start class org.apache.hadoop.io.DoubleWritable -->
- <class name="DoubleWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="DoubleWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="DoubleWritable" type="double"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="double"/>
- </method>
- <method name="get" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a DoubleWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.io.DoubleWritable"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Writable for Double values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.DoubleWritable -->
- <!-- start class org.apache.hadoop.io.ElasticByteBufferPool -->
- <class name="ElasticByteBufferPool" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.ByteBufferPool"/>
- <constructor name="ElasticByteBufferPool"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getBuffer" return="java.nio.ByteBuffer"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="direct" type="boolean"/>
- <param name="length" type="int"/>
- </method>
- <method name="putBuffer"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buffer" type="java.nio.ByteBuffer"/>
- </method>
- <doc>
- <![CDATA[This is a simple ByteBufferPool which just creates ByteBuffers as needed.
- It also caches ByteBuffers after they're released. It will always return
- the smallest cached buffer with at least the capacity you request.
- We don't try to do anything clever here like try to limit the maximum cache
- size.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ElasticByteBufferPool -->
- <!-- start class org.apache.hadoop.io.EnumSetWritable -->
- <class name="EnumSetWritable" extends="java.util.AbstractCollection"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="EnumSetWritable" type="java.util.EnumSet, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a new EnumSetWritable. If the <tt>value</tt> argument is null or
- its size is zero, the <tt>elementType</tt> argument must not be null. If
- the argument <tt>value</tt>'s size is bigger than zero, the argument
- <tt>elementType</tt> is not be used.
-
- @param value
- @param elementType]]>
- </doc>
- </constructor>
- <constructor name="EnumSetWritable" type="java.util.EnumSet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a new EnumSetWritable. Argument <tt>value</tt> should not be null
- or empty.
-
- @param value]]>
- </doc>
- </constructor>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="add" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="e" type="E"/>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.util.EnumSet"/>
- <param name="elementType" type="java.lang.Class"/>
- <doc>
- <![CDATA[reset the EnumSetWritable with specified
- <tt>value</value> and <tt>elementType</tt>. If the <tt>value</tt> argument
- is null or its size is zero, the <tt>elementType</tt> argument must not be
- null. If the argument <tt>value</tt>'s size is bigger than zero, the
- argument <tt>elementType</tt> is not be used.
-
- @param value
- @param elementType]]>
- </doc>
- </method>
- <method name="get" return="java.util.EnumSet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this EnumSetWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true if <code>o</code> is an EnumSetWritable with the same value,
- or both are null.]]>
- </doc>
- </method>
- <method name="getElementType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the class of all the elements of the underlying EnumSetWriable. It
- may return null.
-
- @return the element class]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <doc>
- <![CDATA[A Writable wrapper for EnumSet.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.EnumSetWritable -->
- <!-- start class org.apache.hadoop.io.FloatWritable -->
- <class name="FloatWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="FloatWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FloatWritable" type="float"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="float"/>
- <doc>
- <![CDATA[Set the value of this FloatWritable.]]>
- </doc>
- </method>
- <method name="get" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this FloatWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a FloatWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.io.FloatWritable"/>
- <doc>
- <![CDATA[Compares two FloatWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for floats.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.FloatWritable -->
- <!-- start class org.apache.hadoop.io.GenericWritable -->
- <class name="GenericWritable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="GenericWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="org.apache.hadoop.io.Writable"/>
- <doc>
- <![CDATA[Set the instance that is wrapped.
-
- @param obj]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the wrapped instance.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getTypes" return="java.lang.Class[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return all classes that may be wrapped. Subclasses should implement this
- to return a constant array of classes.]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <doc>
- <![CDATA[A wrapper for Writable instances.
- <p>
- When two sequence files, which have same Key type but different Value
- types, are mapped out to reduce, multiple Value types is not allowed.
- In this case, this class can help you wrap instances with different types.
- </p>
-
- <p>
- Compared with <code>ObjectWritable</code>, this class is much more effective,
- because <code>ObjectWritable</code> will append the class declaration as a String
- into the output file in every Key-Value pair.
- </p>
-
- <p>
- Generic Writable implements {@link Configurable} interface, so that it will be
- configured by the framework. The configuration is passed to the wrapped objects
- implementing {@link Configurable} interface <i>before deserialization</i>.
- </p>
-
- how to use it: <br>
- 1. Write your own class, such as GenericObject, which extends GenericWritable.<br>
- 2. Implements the abstract method <code>getTypes()</code>, defines
- the classes which will be wrapped in GenericObject in application.
- Attention: this classes defined in <code>getTypes()</code> method, must
- implement <code>Writable</code> interface.
- <br><br>
-
- The code looks like this:
- <blockquote><pre>
- public class GenericObject extends GenericWritable {
-
- private static Class[] CLASSES = {
- ClassType1.class,
- ClassType2.class,
- ClassType3.class,
- };
- protected Class[] getTypes() {
- return CLASSES;
- }
- }
- </pre></blockquote>
-
- @since Nov 8, 2006]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.GenericWritable -->
- <!-- start class org.apache.hadoop.io.IntWritable -->
- <class name="IntWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="IntWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="IntWritable" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Set the value of this IntWritable.]]>
- </doc>
- </method>
- <method name="get" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this IntWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a IntWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.io.IntWritable"/>
- <doc>
- <![CDATA[Compares two IntWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for ints.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.IntWritable -->
- <!-- start class org.apache.hadoop.io.IOUtils -->
- <class name="IOUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="IOUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="copyBytes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="out" type="java.io.OutputStream"/>
- <param name="buffSize" type="int"/>
- <param name="close" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copies from one stream to another.
- @param in InputStrem to read from
- @param out OutputStream to write to
- @param buffSize the size of the buffer
- @param close whether or not close the InputStream and
- OutputStream at the end. The streams are closed in the finally clause.]]>
- </doc>
- </method>
- <method name="copyBytes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="out" type="java.io.OutputStream"/>
- <param name="buffSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copies from one stream to another.
-
- @param in InputStrem to read from
- @param out OutputStream to write to
- @param buffSize the size of the buffer]]>
- </doc>
- </method>
- <method name="copyBytes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="out" type="java.io.OutputStream"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copies from one stream to another. <strong>closes the input and output streams
- at the end</strong>.
- @param in InputStrem to read from
- @param out OutputStream to write to
- @param conf the Configuration object]]>
- </doc>
- </method>
- <method name="copyBytes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="out" type="java.io.OutputStream"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="close" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copies from one stream to another.
- @param in InputStream to read from
- @param out OutputStream to write to
- @param conf the Configuration object
- @param close whether or not close the InputStream and
- OutputStream at the end. The streams are closed in the finally clause.]]>
- </doc>
- </method>
- <method name="copyBytes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="out" type="java.io.OutputStream"/>
- <param name="count" type="long"/>
- <param name="close" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copies count bytes from one stream to another.
- @param in InputStream to read from
- @param out OutputStream to write to
- @param count number of bytes to copy
- @param close whether to close the streams
- @throws IOException if bytes can not be read or written]]>
- </doc>
- </method>
- <method name="wrappedReadForCompressedData" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="is" type="java.io.InputStream"/>
- <param name="buf" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Utility wrapper for reading from {@link InputStream}. It catches any errors
- thrown by the underlying stream (either IO or decompression-related), and
- re-throws as an IOException.
-
- @param is - InputStream to be read from
- @param buf - buffer the data is read into
- @param off - offset within buf
- @param len - amount of data to be read
- @return number of bytes read]]>
- </doc>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="buf" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads len bytes in a loop.
- @param in InputStream to read from
- @param buf The buffer to fill
- @param off offset from the buffer
- @param len the length of bytes to read
- @throws IOException if it could not read requested number of bytes
- for any reason (including EOF)]]>
- </doc>
- </method>
- <method name="skipFully"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="len" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Similar to readFully(). Skips bytes in a loop.
- @param in The InputStream to skip bytes from
- @param len number of bytes to skip.
- @throws IOException if it could not skip requested number of bytes
- for any reason (including EOF)]]>
- </doc>
- </method>
- <method name="cleanup"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="use {@link #cleanupWithLogger(Logger, java.io.Closeable...)}
- instead">
- <param name="log" type="org.apache.commons.logging.Log"/>
- <param name="closeables" type="java.io.Closeable[]"/>
- <doc>
- <![CDATA[Close the Closeable objects and <b>ignore</b> any {@link Throwable} or
- null pointers. Must only be used for cleanup in exception handlers.
- @param log the log to record problems to at debug level. Can be null.
- @param closeables the objects to close
- @deprecated use {@link #cleanupWithLogger(Logger, java.io.Closeable...)}
- instead]]>
- </doc>
- </method>
- <method name="cleanupWithLogger"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logger" type="org.slf4j.Logger"/>
- <param name="closeables" type="java.io.Closeable[]"/>
- <doc>
- <![CDATA[Close the Closeable objects and <b>ignore</b> any {@link Throwable} or
- null pointers. Must only be used for cleanup in exception handlers.
- @param logger the log to record problems to at debug level. Can be null.
- @param closeables the objects to close]]>
- </doc>
- </method>
- <method name="closeStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.Closeable"/>
- <doc>
- <![CDATA[Closes the stream ignoring {@link Throwable}.
- Must only be called in cleaning up from exception handlers.
- @param stream the Stream to close]]>
- </doc>
- </method>
- <method name="closeStreams"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="streams" type="java.io.Closeable[]"/>
- <doc>
- <![CDATA[Closes the streams ignoring {@link Throwable}.
- Must only be called in cleaning up from exception handlers.
- @param streams the Streams to close]]>
- </doc>
- </method>
- <method name="closeSocket"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sock" type="java.net.Socket"/>
- <doc>
- <![CDATA[Closes the socket ignoring {@link IOException}
- @param sock the Socket to close]]>
- </doc>
- </method>
- <method name="writeFully"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bc" type="java.nio.channels.WritableByteChannel"/>
- <param name="buf" type="java.nio.ByteBuffer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a ByteBuffer to a WritableByteChannel, handling short writes.
-
- @param bc The WritableByteChannel to write to
- @param buf The input buffer
- @throws IOException On I/O error]]>
- </doc>
- </method>
- <method name="writeFully"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fc" type="java.nio.channels.FileChannel"/>
- <param name="buf" type="java.nio.ByteBuffer"/>
- <param name="offset" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a ByteBuffer to a FileChannel at a given offset,
- handling short writes.
-
- @param fc The FileChannel to write to
- @param buf The input buffer
- @param offset The offset in the file to start writing at
- @throws IOException On I/O error]]>
- </doc>
- </method>
- <method name="listDirectory" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <param name="filter" type="java.io.FilenameFilter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the complete list of files in a directory as strings.<p/>
- This is better than File#listDir because it does not ignore IOExceptions.
- @param dir The directory to list.
- @param filter If non-null, the filter to use when listing
- this directory.
- @return The list of files in the directory.
- @throws IOException On I/O error]]>
- </doc>
- </method>
- <method name="fsync"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fileToSync" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Ensure that any writes to the given file is written to the storage device
- that contains it. This method opens channel on given File and closes it
- once the sync is done.<br>
- Borrowed from Uwe Schindler in LUCENE-5588
- @param fileToSync the file to fsync]]>
- </doc>
- </method>
- <method name="fsync"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="channel" type="java.nio.channels.FileChannel"/>
- <param name="isDir" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Ensure that any writes to the given file is written to the storage device
- that contains it. This method opens channel on given File and closes it
- once the sync is done.
- Borrowed from Uwe Schindler in LUCENE-5588
- @param channel Channel to sync
- @param isDir if true, the given file is a directory (Channel should be
- opened for read and ignore IOExceptions, because not all file
- systems and operating systems allow to fsync on a directory)
- @throws IOException]]>
- </doc>
- </method>
- <method name="readFullyToByteArray" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a DataInput until EOF and returns a byte array. Make sure not to
- pass in an infinite DataInput or this will never return.
- @param in A DataInput
- @return a byte array containing the data from the DataInput
- @throws IOException on I/O error, other than EOF]]>
- </doc>
- </method>
- <field name="LOG" type="org.slf4j.Logger"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An utility class for I/O related functionality.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.IOUtils -->
- <!-- start class org.apache.hadoop.io.LongWritable -->
- <class name="LongWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="LongWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="LongWritable" type="long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Set the value of this LongWritable.]]>
- </doc>
- </method>
- <method name="get" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this LongWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a LongWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.io.LongWritable"/>
- <doc>
- <![CDATA[Compares two LongWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for longs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.LongWritable -->
- <!-- start class org.apache.hadoop.io.MapFile -->
- <class name="MapFile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MapFile"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="rename"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="oldName" type="java.lang.String"/>
- <param name="newName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Renames an existing map directory.]]>
- </doc>
- </method>
- <method name="delete"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deletes the named map file.]]>
- </doc>
- </method>
- <method name="fix" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valueClass" type="java.lang.Class"/>
- <param name="dryrun" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[This method attempts to fix a corrupt MapFile by re-creating its index.
- @param fs filesystem
- @param dir directory containing the MapFile data and index
- @param keyClass key class (has to be a subclass of Writable)
- @param valueClass value class (has to be a subclass of Writable)
- @param dryrun do not perform any changes, just report what needs to be done
- @return number of valid entries in this MapFile, or -1 if no fixing was needed
- @throws Exception]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <field name="INDEX_FILE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name of the index file.]]>
- </doc>
- </field>
- <field name="DATA_FILE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name of the data file.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A file-based map from keys to values.
-
- <p>A map is a directory containing two files, the <code>data</code> file,
- containing all keys and values in the map, and a smaller <code>index</code>
- file, containing a fraction of the keys. The fraction is determined by
- {@link Writer#getIndexInterval()}.
- <p>The index file is read entirely into memory. Thus key implementations
- should try to keep themselves small.
- <p>Map files are created by adding entries in-order. To maintain a large
- database, perform updates by copying the previous version of a database and
- merging in a sorted change list, to create a new version of the database in
- a new file. Sorting large change lists can be done with {@link
- SequenceFile.Sorter}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MapFile -->
- <!-- start class org.apache.hadoop.io.MapWritable -->
- <class name="MapWritable" extends="org.apache.hadoop.io.AbstractMapWritable"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.Map"/>
- <constructor name="MapWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor.]]>
- </doc>
- </constructor>
- <constructor name="MapWritable" type="org.apache.hadoop.io.MapWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Copy constructor.
-
- @param other the map to copy from]]>
- </doc>
- </constructor>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="containsKey" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- </method>
- <method name="containsValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.Object"/>
- </method>
- <method name="entrySet" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isEmpty" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="keySet" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="put" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Writable"/>
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- </method>
- <method name="putAll"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="java.util.Map"/>
- </method>
- <method name="remove" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="values" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A Writable Map.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MapWritable -->
- <!-- start class org.apache.hadoop.io.MD5Hash -->
- <class name="MD5Hash" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="MD5Hash"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs an MD5Hash.]]>
- </doc>
- </constructor>
- <constructor name="MD5Hash" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs an MD5Hash from a hex string.]]>
- </doc>
- </constructor>
- <constructor name="MD5Hash" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs an MD5Hash with a specified value.]]>
- </doc>
- </constructor>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructs, reads and returns an instance.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.io.MD5Hash"/>
- <doc>
- <![CDATA[Copy the contents of another instance into this instance.]]>
- </doc>
- </method>
- <method name="getDigest" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the digest bytes.]]>
- </doc>
- </method>
- <method name="digest" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="data" type="byte[]"/>
- <doc>
- <![CDATA[Construct a hash value for a byte array.]]>
- </doc>
- </method>
- <method name="getDigester" return="java.security.MessageDigest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a thread local MD5 digester]]>
- </doc>
- </method>
- <method name="digest" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a hash value for the content from the InputStream.]]>
- </doc>
- </method>
- <method name="digest" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="data" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Construct a hash value for a byte array.]]>
- </doc>
- </method>
- <method name="digest" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <doc>
- <![CDATA[Construct a hash value for a String.]]>
- </doc>
- </method>
- <method name="digest" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="org.apache.hadoop.io.UTF8"/>
- <doc>
- <![CDATA[Construct a hash value for a String.]]>
- </doc>
- </method>
- <method name="halfDigest" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a half-sized version of this MD5. Fits in a long]]>
- </doc>
- </method>
- <method name="quarterDigest" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a 32-bit digest of the MD5.
- @return the first 4 bytes of the md5]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is an MD5Hash whose digest contains the
- same values.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a hash code value for this object.
- Only uses the first 4 bytes, since md5s are evenly distributed.]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.io.MD5Hash"/>
- <doc>
- <![CDATA[Compares this object with the specified object for order.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a string representation of this object.]]>
- </doc>
- </method>
- <method name="setDigest"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hex" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the digest value from a hex string.]]>
- </doc>
- </method>
- <field name="MD5_LEN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A Writable for MD5 hash values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MD5Hash -->
- <!-- start class org.apache.hadoop.io.MultipleIOException -->
- <class name="MultipleIOException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getExceptions" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the underlying exceptions]]>
- </doc>
- </method>
- <method name="createIOException" return="java.io.IOException"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="exceptions" type="java.util.List"/>
- <doc>
- <![CDATA[A convenient method to create an {@link IOException}.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Encapsulate a list of {@link IOException} into an {@link IOException}]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MultipleIOException -->
- <!-- start class org.apache.hadoop.io.NullWritable -->
- <class name="NullWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <method name="get" return="org.apache.hadoop.io.NullWritable"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the single instance of this class.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.io.NullWritable"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Singleton Writable with no data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.NullWritable -->
- <!-- start class org.apache.hadoop.io.ObjectWritable -->
- <class name="ObjectWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="ObjectWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ObjectWritable" type="java.lang.Object"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ObjectWritable" type="java.lang.Class, java.lang.Object"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="get" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the instance, or null if none.]]>
- </doc>
- </method>
- <method name="getDeclaredClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the class this is meant to be.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="instance" type="java.lang.Object"/>
- <doc>
- <![CDATA[Reset the instance.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeObject"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="instance" type="java.lang.Object"/>
- <param name="declaredClass" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a {@link Writable}, {@link String}, primitive type, or an array of
- the preceding.]]>
- </doc>
- </method>
- <method name="writeObject"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="instance" type="java.lang.Object"/>
- <param name="declaredClass" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="allowCompactArrays" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a {@link Writable}, {@link String}, primitive type, or an array of
- the preceding.
-
- @param allowCompactArrays - set true for RPC and internal or intra-cluster
- usages. Set false for inter-cluster, File, and other persisted output
- usages, to preserve the ability to interchange files with other clusters
- that may not be running the same version of software. Sometime in ~2013
- we can consider removing this parameter and always using the compact format.]]>
- </doc>
- </method>
- <method name="readObject" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a {@link Writable}, {@link String}, primitive type, or an array of
- the preceding.]]>
- </doc>
- </method>
- <method name="readObject" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="objectWritable" type="org.apache.hadoop.io.ObjectWritable"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a {@link Writable}, {@link String}, primitive type, or an array of
- the preceding.]]>
- </doc>
- </method>
- <method name="loadClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="className" type="java.lang.String"/>
- <doc>
- <![CDATA[Find and load the class with given name <tt>className</tt> by first finding
- it in the specified <tt>conf</tt>. If the specified <tt>conf</tt> is null,
- try load it directly.]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A polymorphic Writable that writes an instance with it's class name.
- Handles arrays, strings and primitive types without a Writable wrapper.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ObjectWritable -->
- <!-- start interface org.apache.hadoop.io.RawComparator -->
- <interface name="RawComparator" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.Comparator"/>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- <doc>
- <![CDATA[Compare two objects in binary.
- b1[s1:l1] is the first object, and b2[s2:l2] is the second object.
-
- @param b1 The first byte array.
- @param s1 The position index in b1. The object under comparison's starting index.
- @param l1 The length of the object in b1.
- @param b2 The second byte array.
- @param s2 The position index in b2. The object under comparison's starting index.
- @param l2 The length of the object under comparison in b2.
- @return An integer result of the comparison.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- A {@link Comparator} that operates directly on byte representations of
- objects.
- </p>
- @param <T>
- @see DeserializerComparator]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.RawComparator -->
- <!-- start class org.apache.hadoop.io.SequenceFile -->
- <class name="SequenceFile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getDefaultCompressionType" return="org.apache.hadoop.io.SequenceFile.CompressionType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the compression type for the reduce outputs
- @param job the job config to look in
- @return the kind of compression to use]]>
- </doc>
- </method>
- <method name="setDefaultCompressionType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.conf.Configuration"/>
- <param name="val" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <doc>
- <![CDATA[Set the default compression type for sequence files.
- @param job the configuration to modify
- @param val the new compression type (none, block, record)]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="opts" type="org.apache.hadoop.io.SequenceFile.Writer.Option[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a new Writer with the given options.
- @param conf the configuration to use
- @param opts the options to create the file with
- @return a new Writer
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException
- @deprecated Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException
- @deprecated Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param progress The Progressable object to track progress.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException
- @deprecated Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException
- @deprecated Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @param progress The Progressable object to track progress.
- @param metadata The metadata of the file.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException
- @deprecated Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param bufferSize buffer size for the underlaying outputstream.
- @param replication replication factor for the file.
- @param blockSize block size for the file.
- @param compressionType The compression type.
- @param codec The compression codec.
- @param progress The Progressable object to track progress.
- @param metadata The metadata of the file.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException
- @deprecated Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="createParent" type="boolean"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param bufferSize buffer size for the underlaying outputstream.
- @param replication replication factor for the file.
- @param blockSize block size for the file.
- @param createParent create parent directory if non-existent
- @param compressionType The compression type.
- @param codec The compression codec.
- @param metadata The metadata of the file.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fc" type="org.apache.hadoop.fs.FileContext"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
- <param name="createFlag" type="java.util.EnumSet"/>
- <param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fc The context for the specified file.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @param metadata The metadata of the file.
- @param createFlag gives the semantics of create: overwrite, append etc.
- @param opts file creation options; see {@link CreateOpts}.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @param progress The Progressable object to track progress.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException
- @deprecated Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="out" type="org.apache.hadoop.fs.FSDataOutputStream"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of 'raw' SequenceFile Writer.
- @param conf The configuration.
- @param out The stream on top which the writer is to be constructed.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @param metadata The metadata of the file.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException
- @deprecated Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="out" type="org.apache.hadoop.fs.FSDataOutputStream"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of 'raw' SequenceFile Writer.
- @param conf The configuration.
- @param out The stream on top which the writer is to be constructed.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException
- @deprecated Use {@link #createWriter(Configuration, Writer.Option...)}
- instead.]]>
- </doc>
- </method>
- <field name="SYNC_INTERVAL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of bytes between sync points.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[<code>SequenceFile</code>s are flat files consisting of binary key/value
- pairs.
-
- <p><code>SequenceFile</code> provides {@link SequenceFile.Writer},
- {@link SequenceFile.Reader} and {@link Sorter} classes for writing,
- reading and sorting respectively.</p>
-
- There are three <code>SequenceFile</code> <code>Writer</code>s based on the
- {@link CompressionType} used to compress key/value pairs:
- <ol>
- <li>
- <code>Writer</code> : Uncompressed records.
- </li>
- <li>
- <code>RecordCompressWriter</code> : Record-compressed files, only compress
- values.
- </li>
- <li>
- <code>BlockCompressWriter</code> : Block-compressed files, both keys &
- values are collected in 'blocks'
- separately and compressed. The size of
- the 'block' is configurable.
- </ol>
-
- <p>The actual compression algorithm used to compress key and/or values can be
- specified by using the appropriate {@link CompressionCodec}.</p>
-
- <p>The recommended way is to use the static <tt>createWriter</tt> methods
- provided by the <code>SequenceFile</code> to chose the preferred format.</p>
- <p>The {@link SequenceFile.Reader} acts as the bridge and can read any of the
- above <code>SequenceFile</code> formats.</p>
- <h4 id="Formats">SequenceFile Formats</h4>
-
- <p>Essentially there are 3 different formats for <code>SequenceFile</code>s
- depending on the <code>CompressionType</code> specified. All of them share a
- <a href="#Header">common header</a> described below.
-
- <h5 id="Header">SequenceFile Header</h5>
- <ul>
- <li>
- version - 3 bytes of magic header <b>SEQ</b>, followed by 1 byte of actual
- version number (e.g. SEQ4 or SEQ6)
- </li>
- <li>
- keyClassName -key class
- </li>
- <li>
- valueClassName - value class
- </li>
- <li>
- compression - A boolean which specifies if compression is turned on for
- keys/values in this file.
- </li>
- <li>
- blockCompression - A boolean which specifies if block-compression is
- turned on for keys/values in this file.
- </li>
- <li>
- compression codec - <code>CompressionCodec</code> class which is used for
- compression of keys and/or values (if compression is
- enabled).
- </li>
- <li>
- metadata - {@link Metadata} for this file.
- </li>
- <li>
- sync - A sync marker to denote end of the header.
- </li>
- </ul>
-
- <h5 id="#UncompressedFormat">Uncompressed SequenceFile Format</h5>
- <ul>
- <li>
- <a href="#Header">Header</a>
- </li>
- <li>
- Record
- <ul>
- <li>Record length</li>
- <li>Key length</li>
- <li>Key</li>
- <li>Value</li>
- </ul>
- </li>
- <li>
- A sync-marker every few <code>100</code> bytes or so.
- </li>
- </ul>
- <h5 id="#RecordCompressedFormat">Record-Compressed SequenceFile Format</h5>
- <ul>
- <li>
- <a href="#Header">Header</a>
- </li>
- <li>
- Record
- <ul>
- <li>Record length</li>
- <li>Key length</li>
- <li>Key</li>
- <li><i>Compressed</i> Value</li>
- </ul>
- </li>
- <li>
- A sync-marker every few <code>100</code> bytes or so.
- </li>
- </ul>
-
- <h5 id="#BlockCompressedFormat">Block-Compressed SequenceFile Format</h5>
- <ul>
- <li>
- <a href="#Header">Header</a>
- </li>
- <li>
- Record <i>Block</i>
- <ul>
- <li>Uncompressed number of records in the block</li>
- <li>Compressed key-lengths block-size</li>
- <li>Compressed key-lengths block</li>
- <li>Compressed keys block-size</li>
- <li>Compressed keys block</li>
- <li>Compressed value-lengths block-size</li>
- <li>Compressed value-lengths block</li>
- <li>Compressed values block-size</li>
- <li>Compressed values block</li>
- </ul>
- </li>
- <li>
- A sync-marker every block.
- </li>
- </ul>
-
- <p>The compressed blocks of key lengths and value lengths consist of the
- actual lengths of individual keys/values encoded in ZeroCompressedInteger
- format.</p>
-
- @see CompressionCodec]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SequenceFile -->
- <!-- start class org.apache.hadoop.io.SetFile -->
- <class name="SetFile" extends="org.apache.hadoop.io.MapFile"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SetFile"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A file-based set of keys.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SetFile -->
- <!-- start class org.apache.hadoop.io.ShortWritable -->
- <class name="ShortWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="ShortWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ShortWritable" type="short"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="short"/>
- <doc>
- <![CDATA[Set the value of this ShortWritable.]]>
- </doc>
- </method>
- <method name="get" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this ShortWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[read the short value]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[write short value]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a ShortWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[hash code]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.io.ShortWritable"/>
- <doc>
- <![CDATA[Compares two ShortWritable.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Short values in string format]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A WritableComparable for shorts.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ShortWritable -->
- <!-- start class org.apache.hadoop.io.SortedMapWritable -->
- <class name="SortedMapWritable" extends="org.apache.hadoop.io.AbstractMapWritable"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.SortedMap"/>
- <constructor name="SortedMapWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[default constructor.]]>
- </doc>
- </constructor>
- <constructor name="SortedMapWritable" type="org.apache.hadoop.io.SortedMapWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Copy constructor.
-
- @param other the map to copy from]]>
- </doc>
- </constructor>
- <method name="comparator" return="java.util.Comparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="firstKey" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="headMap" return="java.util.SortedMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="toKey" type="org.apache.hadoop.io.WritableComparable"/>
- </method>
- <method name="lastKey" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="subMap" return="java.util.SortedMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fromKey" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="toKey" type="org.apache.hadoop.io.WritableComparable"/>
- </method>
- <method name="tailMap" return="java.util.SortedMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fromKey" type="org.apache.hadoop.io.WritableComparable"/>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="containsKey" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- </method>
- <method name="containsValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.Object"/>
- </method>
- <method name="entrySet" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- </method>
- <method name="isEmpty" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="keySet" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="put" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- </method>
- <method name="putAll"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="java.util.Map"/>
- </method>
- <method name="remove" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="values" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A Writable SortedMap.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SortedMapWritable -->
- <!-- start interface org.apache.hadoop.io.Stringifier -->
- <interface name="Stringifier" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="T"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Converts the object to a string representation
- @param obj the object to convert
- @return the string representation of the object
- @throws IOException if the object cannot be converted]]>
- </doc>
- </method>
- <method name="fromString" return="T"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Restores the object from its string representation.
- @param str the string representation of the object
- @return restored object
- @throws IOException if the object cannot be restored]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Closes this object.
- @throws IOException if an I/O error occurs]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Stringifier interface offers two methods to convert an object
- to a string representation and restore the object given its
- string representation.
- @param <T> the class of the objects to stringify]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.Stringifier -->
- <!-- start class org.apache.hadoop.io.Text -->
- <class name="Text" extends="org.apache.hadoop.io.BinaryComparable"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Text" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct from a string.]]>
- </doc>
- </constructor>
- <constructor name="Text" type="org.apache.hadoop.io.Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct from another text.]]>
- </doc>
- </constructor>
- <constructor name="Text" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct from a byte array.]]>
- </doc>
- </constructor>
- <method name="copyBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a copy of the bytes that is exactly the length of the data.
- See {@link #getBytes()} for faster access to the underlying array.]]>
- </doc>
- </method>
- <method name="getBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the raw bytes; however, only data up to {@link #getLength()} is
- valid. Please use {@link #copyBytes()} if you
- need the returned array to be precisely the length of the data.]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of bytes in the byte array]]>
- </doc>
- </method>
- <method name="charAt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="int"/>
- <doc>
- <![CDATA[Returns the Unicode Scalar Value (32-bit integer value)
- for the character at <code>position</code>. Note that this
- method avoids using the converter or doing String instantiation
- @return the Unicode scalar value at position or -1
- if the position is invalid or points to a
- trailing byte]]>
- </doc>
- </method>
- <method name="find" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="what" type="java.lang.String"/>
- </method>
- <method name="find" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="what" type="java.lang.String"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Finds any occurence of <code>what</code> in the backing
- buffer, starting as position <code>start</code>. The starting
- position is measured in bytes and the return value is in
- terms of byte position in the buffer. The backing buffer is
- not converted to a string for this operation.
- @return byte position of the first occurence of the search
- string in the UTF-8 buffer or -1 if not found]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <doc>
- <![CDATA[Set to contain the contents of a string.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <doc>
- <![CDATA[Set to a utf8 byte array]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[copy a text.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Set the Text to range of bytes
- @param utf8 the data to copy from
- @param start the first position of the new string
- @param len the number of bytes of the new string]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Append a range of bytes to the end of the given text
- @param utf8 the data to copy from
- @param start the first position to append from utf8
- @param len the number of bytes to append]]>
- </doc>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clear the string to empty.
- <em>Note</em>: For performance reasons, this call does not clear the
- underlying byte array that is retrievable via {@link #getBytes()}.
- In order to free the byte-array memory, call {@link #set(byte[])}
- with an empty byte array (For example, <code>new byte[0]</code>).]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convert text back to string
- @see java.lang.Object#toString()]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[deserialize]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="maxLength" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="skip"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Skips over one Text in the input.]]>
- </doc>
- </method>
- <method name="readWithKnownLength"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a Text object whose length is already known.
- This allows creating Text from a stream which uses a different serialization
- format.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[serialize
- write this object to out
- length uses zero-compressed encoding
- @see Writable#write(DataOutput)]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="maxLength" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a Text with the same contents.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="decode" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
- <doc>
- <![CDATA[Converts the provided byte array to a String using the
- UTF-8 encoding. If the input is malformed,
- replace by a default value.]]>
- </doc>
- </method>
- <method name="decode" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="length" type="int"/>
- <exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
- </method>
- <method name="decode" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="length" type="int"/>
- <param name="replace" type="boolean"/>
- <exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
- <doc>
- <![CDATA[Converts the provided byte array to a String using the
- UTF-8 encoding. If <code>replace</code> is true, then
- malformed input is replaced with the
- substitution character, which is U+FFFD. Otherwise the
- method throws a MalformedInputException.]]>
- </doc>
- </method>
- <method name="encode" return="java.nio.ByteBuffer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
- <doc>
- <![CDATA[Converts the provided String to bytes using the
- UTF-8 encoding. If the input is malformed,
- invalid chars are replaced by a default value.
- @return ByteBuffer: bytes stores at ByteBuffer.array()
- and length is ByteBuffer.limit()]]>
- </doc>
- </method>
- <method name="encode" return="java.nio.ByteBuffer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <param name="replace" type="boolean"/>
- <exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
- <doc>
- <![CDATA[Converts the provided String to bytes using the
- UTF-8 encoding. If <code>replace</code> is true, then
- malformed input is replaced with the
- substitution character, which is U+FFFD. Otherwise the
- method throws a MalformedInputException.
- @return ByteBuffer: bytes stores at ByteBuffer.array()
- and length is ByteBuffer.limit()]]>
- </doc>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a UTF8 encoded string from in]]>
- </doc>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="maxLength" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a UTF8 encoded string with a maximum size]]>
- </doc>
- </method>
- <method name="writeString" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a UTF8 encoded string to out]]>
- </doc>
- </method>
- <method name="writeString" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String"/>
- <param name="maxLength" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a UTF8 encoded string with a maximum size to out]]>
- </doc>
- </method>
- <method name="validateUTF8"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <exception name="MalformedInputException" type="java.nio.charset.MalformedInputException"/>
- <doc>
- <![CDATA[Check if a byte array contains valid utf-8
- @param utf8 byte array
- @throws MalformedInputException if the byte array contains invalid utf-8]]>
- </doc>
- </method>
- <method name="validateUTF8"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="len" type="int"/>
- <exception name="MalformedInputException" type="java.nio.charset.MalformedInputException"/>
- <doc>
- <![CDATA[Check to see if a byte array is valid utf-8
- @param utf8 the array of bytes
- @param start the offset of the first byte in the array
- @param len the length of the byte sequence
- @throws MalformedInputException if the byte array contains invalid bytes]]>
- </doc>
- </method>
- <method name="bytesToCodePoint" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="java.nio.ByteBuffer"/>
- <doc>
- <![CDATA[Returns the next code point at the current position in
- the buffer. The buffer's position will be incremented.
- Any mark set on this buffer will be changed by this method!]]>
- </doc>
- </method>
- <method name="utf8Length" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <doc>
- <![CDATA[For the given string, returns the number of UTF-8 bytes
- required to encode the string.
- @param string text to encode
- @return number of UTF-8 bytes required to encode]]>
- </doc>
- </method>
- <field name="DEFAULT_MAX_LEN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class stores text using standard UTF8 encoding. It provides methods
- to serialize, deserialize, and compare texts at byte level. The type of
- length is integer and is serialized using zero-compressed format. <p>In
- addition, it provides methods for string traversal without converting the
- byte array to a string. <p>Also includes utilities for
- serializing/deserialing a string, coding/decoding a string, checking if a
- byte array contains valid UTF8 code, calculating the length of an encoded
- string.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.Text -->
- <!-- start class org.apache.hadoop.io.TwoDArrayWritable -->
- <class name="TwoDArrayWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="TwoDArrayWritable" type="java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TwoDArrayWritable" type="java.lang.Class, org.apache.hadoop.io.Writable[][]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="toArray" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="values" type="org.apache.hadoop.io.Writable[][]"/>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable[][]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A Writable for 2D arrays containing a matrix of instances of a class.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.TwoDArrayWritable -->
- <!-- start class org.apache.hadoop.io.VersionedWritable -->
- <class name="VersionedWritable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="VersionedWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getVersion" return="byte"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the version number of the current implementation.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A base class for Writables that provides version checking.
- <p>This is useful when a class may evolve, so that instances written by the
- old version of the class may still be processed by the new version. To
- handle this situation, {@link #readFields(DataInput)}
- implementations should catch {@link VersionMismatchException}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.VersionedWritable -->
- <!-- start class org.apache.hadoop.io.VersionMismatchException -->
- <class name="VersionMismatchException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="VersionMismatchException" type="byte, byte"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a string representation of this object.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Thrown by {@link VersionedWritable#readFields(DataInput)} when the
- version of an object being read does not match the current implementation
- version as returned by {@link VersionedWritable#getVersion()}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.VersionMismatchException -->
- <!-- start class org.apache.hadoop.io.VIntWritable -->
- <class name="VIntWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="VIntWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="VIntWritable" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Set the value of this VIntWritable.]]>
- </doc>
- </method>
- <method name="get" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this VIntWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a VIntWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.io.VIntWritable"/>
- <doc>
- <![CDATA[Compares two VIntWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for integer values stored in variable-length format.
- Such values take between one and five bytes. Smaller values take fewer bytes.
-
- @see org.apache.hadoop.io.WritableUtils#readVInt(DataInput)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.VIntWritable -->
- <!-- start class org.apache.hadoop.io.VLongWritable -->
- <class name="VLongWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="VLongWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="VLongWritable" type="long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Set the value of this LongWritable.]]>
- </doc>
- </method>
- <method name="get" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this LongWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a VLongWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.io.VLongWritable"/>
- <doc>
- <![CDATA[Compares two VLongWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for longs in a variable-length format. Such values take
- between one and five bytes. Smaller values take fewer bytes.
-
- @see org.apache.hadoop.io.WritableUtils#readVLong(DataInput)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.VLongWritable -->
- <!-- start interface org.apache.hadoop.io.Writable -->
- <interface name="Writable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize the fields of this object to <code>out</code>.
-
- @param out <code>DataOuput</code> to serialize this object into.
- @throws IOException]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deserialize the fields of this object from <code>in</code>.
-
- <p>For efficiency, implementations should attempt to re-use storage in the
- existing object where possible.</p>
-
- @param in <code>DataInput</code> to deseriablize this object from.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A serializable object which implements a simple, efficient, serialization
- protocol, based on {@link DataInput} and {@link DataOutput}.
- <p>Any <code>key</code> or <code>value</code> type in the Hadoop Map-Reduce
- framework implements this interface.</p>
-
- <p>Implementations typically implement a static <code>read(DataInput)</code>
- method which constructs a new instance, calls {@link #readFields(DataInput)}
- and returns the instance.</p>
-
- <p>Example:</p>
- <p><blockquote><pre>
- public class MyWritable implements Writable {
- // Some data
- private int counter;
- private long timestamp;
-
- public void write(DataOutput out) throws IOException {
- out.writeInt(counter);
- out.writeLong(timestamp);
- }
-
- public void readFields(DataInput in) throws IOException {
- counter = in.readInt();
- timestamp = in.readLong();
- }
-
- public static MyWritable read(DataInput in) throws IOException {
- MyWritable w = new MyWritable();
- w.readFields(in);
- return w;
- }
- }
- </pre></blockquote></p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.Writable -->
- <!-- start interface org.apache.hadoop.io.WritableComparable -->
- <interface name="WritableComparable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Comparable"/>
- <doc>
- <![CDATA[A {@link Writable} which is also {@link Comparable}.
- <p><code>WritableComparable</code>s can be compared to each other, typically
- via <code>Comparator</code>s. Any type which is to be used as a
- <code>key</code> in the Hadoop Map-Reduce framework should implement this
- interface.</p>
- <p>Note that <code>hashCode()</code> is frequently used in Hadoop to partition
- keys. It's important that your implementation of hashCode() returns the same
- result across different instances of the JVM. Note also that the default
- <code>hashCode()</code> implementation in <code>Object</code> does <b>not</b>
- satisfy this property.</p>
-
- <p>Example:</p>
- <p><blockquote><pre>
- public class MyWritableComparable implements WritableComparable<MyWritableComparable> {
- // Some data
- private int counter;
- private long timestamp;
-
- public void write(DataOutput out) throws IOException {
- out.writeInt(counter);
- out.writeLong(timestamp);
- }
-
- public void readFields(DataInput in) throws IOException {
- counter = in.readInt();
- timestamp = in.readLong();
- }
-
- public int compareTo(MyWritableComparable o) {
- int thisValue = this.value;
- int thatValue = o.value;
- return (thisValue < thatValue ? -1 : (thisValue==thatValue ? 0 : 1));
- }
- public int hashCode() {
- final int prime = 31;
- int result = 1;
- result = prime * result + counter;
- result = prime * result + (int) (timestamp ^ (timestamp >>> 32));
- return result
- }
- }
- </pre></blockquote></p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.WritableComparable -->
- <!-- start class org.apache.hadoop.io.WritableComparator -->
- <class name="WritableComparator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.RawComparator"/>
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="WritableComparator"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <constructor name="WritableComparator" type="java.lang.Class"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct for a {@link WritableComparable} implementation.]]>
- </doc>
- </constructor>
- <constructor name="WritableComparator" type="java.lang.Class, boolean"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <constructor name="WritableComparator" type="java.lang.Class, org.apache.hadoop.conf.Configuration, boolean"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="get" return="org.apache.hadoop.io.WritableComparator"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <doc>
- <![CDATA[For backwards compatibility.]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.io.WritableComparator"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get a comparator for a {@link WritableComparable} implementation.]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="define"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <param name="comparator" type="org.apache.hadoop.io.WritableComparator"/>
- <doc>
- <![CDATA[Register an optimized comparator for a {@link WritableComparable}
- implementation. Comparators registered with this method must be
- thread-safe.]]>
- </doc>
- </method>
- <method name="getKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the WritableComparable implementation class.]]>
- </doc>
- </method>
- <method name="newKey" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a new {@link WritableComparable} instance.]]>
- </doc>
- </method>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- <doc>
- <![CDATA[Optimization hook. Override this to make SequenceFile.Sorter's scream.
- <p>The default implementation reads the data into two {@link
- WritableComparable}s (using {@link
- Writable#readFields(DataInput)}, then calls {@link
- #compare(WritableComparable,WritableComparable)}.]]>
- </doc>
- </method>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="a" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="b" type="org.apache.hadoop.io.WritableComparable"/>
- <doc>
- <![CDATA[Compare two WritableComparables.
- <p> The default implementation uses the natural ordering, calling {@link
- Comparable#compareTo(Object)}.]]>
- </doc>
- </method>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="a" type="java.lang.Object"/>
- <param name="b" type="java.lang.Object"/>
- </method>
- <method name="compareBytes" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- <doc>
- <![CDATA[Lexicographic order of binary data.]]>
- </doc>
- </method>
- <method name="hashBytes" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Compute hash for binary data.]]>
- </doc>
- </method>
- <method name="hashBytes" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Compute hash for binary data.]]>
- </doc>
- </method>
- <method name="readUnsignedShort" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse an unsigned short from a byte array.]]>
- </doc>
- </method>
- <method name="readInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse an integer from a byte array.]]>
- </doc>
- </method>
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse a float from a byte array.]]>
- </doc>
- </method>
- <method name="readLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse a long from a byte array.]]>
- </doc>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse a double from a byte array.]]>
- </doc>
- </method>
- <method name="readVLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded long from a byte array and returns it.
- @param bytes byte array with decode long
- @param start starting index
- @throws java.io.IOException
- @return deserialized long]]>
- </doc>
- </method>
- <method name="readVInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded integer from a byte array and returns it.
- @param bytes byte array with the encoded integer
- @param start start index
- @throws java.io.IOException
- @return deserialized integer]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A Comparator for {@link WritableComparable}s.
- <p>This base implemenation uses the natural ordering. To define alternate
- orderings, override {@link #compare(WritableComparable,WritableComparable)}.
- <p>One may optimize compare-intensive operations by overriding
- {@link #compare(byte[],int,int,byte[],int,int)}. Static utility methods are
- provided to assist in optimized implementations of this method.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.WritableComparator -->
- <!-- start class org.apache.hadoop.io.WritableFactories -->
- <class name="WritableFactories" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setFactory"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <param name="factory" type="org.apache.hadoop.io.WritableFactory"/>
- <doc>
- <![CDATA[Define a factory for a class.]]>
- </doc>
- </method>
- <method name="getFactory" return="org.apache.hadoop.io.WritableFactory"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <doc>
- <![CDATA[Define a factory for a class.]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Create a new instance of a class with a defined factory.]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <doc>
- <![CDATA[Create a new instance of a class with a defined factory.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Factories for non-public writables. Defining a factory permits {@link
- ObjectWritable} to be able to construct instances of non-public classes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.WritableFactories -->
- <!-- start interface org.apache.hadoop.io.WritableFactory -->
- <interface name="WritableFactory" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="newInstance" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a new instance.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A factory for a class of Writable.
- @see WritableFactories]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.WritableFactory -->
- <!-- start class org.apache.hadoop.io.WritableUtils -->
- <class name="WritableUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="WritableUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="readCompressedByteArray" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="skipCompressedByteArray"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeCompressedByteArray" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="bytes" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readCompressedString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeCompressedString" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeStringArray"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeCompressedStringArray"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readStringArray" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readCompressedStringArray" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="displayByteArray"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="byte[]"/>
- </method>
- <method name="clone" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="orig" type="T"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Make a copy of a writable object using serialization to a buffer.
- @param orig The object to copy
- @return The copied object]]>
- </doc>
- </method>
- <method name="cloneInto"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="use ReflectionUtils.cloneInto instead.">
- <param name="dst" type="org.apache.hadoop.io.Writable"/>
- <param name="src" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make a copy of the writable object using serialiation to a buffer
- @param dst the object to copy from
- @param src the object to copy into, which is destroyed
- @throws IOException
- @deprecated use ReflectionUtils.cloneInto instead.]]>
- </doc>
- </method>
- <method name="writeVInt"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataOutput"/>
- <param name="i" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serializes an integer to a binary stream with zero-compressed encoding.
- For -112 <= i <= 127, only one byte is used with the actual value.
- For other values of i, the first byte value indicates whether the
- integer is positive or negative, and the number of bytes that follow.
- If the first byte value v is between -113 and -116, the following integer
- is positive, with number of bytes that follow are -(v+112).
- If the first byte value v is between -121 and -124, the following integer
- is negative, with number of bytes that follow are -(v+120). Bytes are
- stored in the high-non-zero-byte-first order.
- @param stream Binary output stream
- @param i Integer to be serialized
- @throws java.io.IOException]]>
- </doc>
- </method>
- <method name="writeVLong"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataOutput"/>
- <param name="i" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serializes a long to a binary stream with zero-compressed encoding.
- For -112 <= i <= 127, only one byte is used with the actual value.
- For other values of i, the first byte value indicates whether the
- long is positive or negative, and the number of bytes that follow.
- If the first byte value v is between -113 and -120, the following long
- is positive, with number of bytes that follow are -(v+112).
- If the first byte value v is between -121 and -128, the following long
- is negative, with number of bytes that follow are -(v+120). Bytes are
- stored in the high-non-zero-byte-first order.
-
- @param stream Binary output stream
- @param i Long to be serialized
- @throws java.io.IOException]]>
- </doc>
- </method>
- <method name="readVLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded long from input stream and returns it.
- @param stream Binary input stream
- @throws java.io.IOException
- @return deserialized long from stream.]]>
- </doc>
- </method>
- <method name="readVInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded integer from input stream and returns it.
- @param stream Binary input stream
- @throws java.io.IOException
- @return deserialized integer from stream.]]>
- </doc>
- </method>
- <method name="readVIntInRange" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataInput"/>
- <param name="lower" type="int"/>
- <param name="upper" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads an integer from the input stream and returns it.
- This function validates that the integer is between [lower, upper],
- inclusive.
- @param stream Binary input stream
- @throws java.io.IOException
- @return deserialized integer from stream]]>
- </doc>
- </method>
- <method name="isNegativeVInt" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="byte"/>
- <doc>
- <![CDATA[Given the first byte of a vint/vlong, determine the sign
- @param value the first byte
- @return is the value negative]]>
- </doc>
- </method>
- <method name="decodeVIntSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="byte"/>
- <doc>
- <![CDATA[Parse the first byte of a vint/vlong to determine the number of bytes
- @param value the first byte of the vint/vlong
- @return the total number of bytes (1 to 9)]]>
- </doc>
- </method>
- <method name="getVIntSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="long"/>
- <doc>
- <![CDATA[Get the encoded length if an integer is stored in a variable-length format
- @return the encoded length]]>
- </doc>
- </method>
- <method name="readEnum" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="enumType" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read an Enum value from DataInput, Enums are read and written
- using String values.
- @param <T> Enum type
- @param in DataInput to read from
- @param enumType Class type of Enum
- @return Enum represented by String read from DataInput
- @throws IOException]]>
- </doc>
- </method>
- <method name="writeEnum"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="enumVal" type="java.lang.Enum"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[writes String value of enum to DataOutput.
- @param out Dataoutput stream
- @param enumVal enum value
- @throws IOException]]>
- </doc>
- </method>
- <method name="skipFully"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Skip <i>len</i> number of bytes in input stream<i>in</i>
- @param in input stream
- @param len number of bytes to skip
- @throws IOException when skipped less number of bytes]]>
- </doc>
- </method>
- <method name="toByteArray" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writables" type="org.apache.hadoop.io.Writable[]"/>
- <doc>
- <![CDATA[Convert writables to a byte array]]>
- </doc>
- </method>
- <method name="readStringSafely" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="maxLength" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[Read a string, but check it for sanity. The format consists of a vint
- followed by the given number of bytes.
- @param in the stream to read from
- @param maxLength the largest acceptable length of the encoded string
- @return the bytes as a string
- @throws IOException if reading from the DataInput fails
- @throws IllegalArgumentException if the encoded byte size for string
- is negative or larger than maxSize. Only the vint is read.]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.io.WritableUtils -->
- <doc>
- <![CDATA[Generic i/o code for use when reading and writing data to the network,
- to databases, and to files.]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.io.compress">
- <!-- start class org.apache.hadoop.io.compress.BlockCompressorStream -->
- <class name="BlockCompressorStream" extends="org.apache.hadoop.io.compress.CompressorStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BlockCompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a {@link BlockCompressorStream}.
-
- @param out stream
- @param compressor compressor to be used
- @param bufferSize size of buffer
- @param compressionOverhead maximum 'overhead' of the compression
- algorithm with given bufferSize]]>
- </doc>
- </constructor>
- <constructor name="BlockCompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a {@link BlockCompressorStream} with given output-stream and
- compressor.
- Use default of 512 as bufferSize and compressionOverhead of
- (1% of bufferSize + 12 bytes) = 18 bytes (zlib algorithm).
-
- @param out stream
- @param compressor compressor to be used]]>
- </doc>
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write the data provided to the compression codec, compressing no more
- than the buffer size less the compression overhead as specified during
- construction for each block.
- Each block contains the uncompressed length for the block, followed by
- one or more length-prefixed blocks of compressed data.]]>
- </doc>
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="compress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A {@link org.apache.hadoop.io.compress.CompressorStream} which works
- with 'block-based' based compression algorithms, as opposed to
- 'stream-based' compression algorithms.
- It should be noted that this wrapper does not guarantee that blocks will
- be sized for the compressor. If the
- {@link org.apache.hadoop.io.compress.Compressor} requires buffering to
- effect meaningful compression, it is responsible for it.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.BlockCompressorStream -->
- <!-- start class org.apache.hadoop.io.compress.BlockDecompressorStream -->
- <class name="BlockDecompressorStream" extends="org.apache.hadoop.io.compress.DecompressorStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BlockDecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link BlockDecompressorStream}.
-
- @param in input stream
- @param decompressor decompressor to use
- @param bufferSize size of buffer
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="BlockDecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link BlockDecompressorStream}.
-
- @param in input stream
- @param decompressor decompressor to use
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="BlockDecompressorStream" type="java.io.InputStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCompressedData" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="resetState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A {@link org.apache.hadoop.io.compress.DecompressorStream} which works
- with 'block-based' based compression algorithms, as opposed to
- 'stream-based' compression algorithms.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.BlockDecompressorStream -->
- <!-- start class org.apache.hadoop.io.compress.BZip2Codec -->
- <class name="BZip2Codec" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <implements name="org.apache.hadoop.io.compress.SplittableCompressionCodec"/>
- <constructor name="BZip2Codec"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of BZip2Codec.]]>
- </doc>
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Set the configuration to be used by this object.
- @param conf the configuration object.]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the configuration used by this object.
- @return the configuration object used by this objec.]]>
- </doc>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionOutputStream} that will write to the given
- {@link OutputStream}.
- @param out the location for the final output stream
- @return a stream the user can write uncompressed data to, to have it
- compressed
- @throws IOException]]>
- </doc>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionOutputStream} that will write to the given
- {@link OutputStream} with the given {@link Compressor}.
- @param out the location for the final output stream
- @param compressor compressor to use
- @return a stream the user can write uncompressed data to, to have it
- compressed
- @throws IOException]]>
- </doc>
- </method>
- <method name="getCompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type of {@link Compressor} needed by this {@link CompressionCodec}.
- @return the type of compressor needed by this codec.]]>
- </doc>
- </method>
- <method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new {@link Compressor} for use by this {@link CompressionCodec}.
- @return a new compressor for use by this codec]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionInputStream} that will read from the given
- input stream and return a stream for uncompressed data.
- @param in the stream to read compressed bytes from
- @return a stream to read uncompressed bytes from
- @throws IOException]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionInputStream} that will read from the given
- {@link InputStream} with the given {@link Decompressor}, and return a
- stream for uncompressed data.
- @param in the stream to read compressed bytes from
- @param decompressor decompressor to use
- @return a stream to read uncompressed bytes from
- @throws IOException]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.SplitCompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="seekableIn" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <param name="start" type="long"/>
- <param name="end" type="long"/>
- <param name="readMode" type="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates CompressionInputStream to be used to read off uncompressed data
- in one of the two reading modes. i.e. Continuous or Blocked reading modes
- @param seekableIn The InputStream
- @param start The start offset into the compressed stream
- @param end The end offset into the compressed stream
- @param readMode Controls whether progress is reported continuously or
- only at block boundaries.
- @return CompressionInputStream for BZip2 aligned at block boundaries]]>
- </doc>
- </method>
- <method name="getDecompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type of {@link Decompressor} needed by this {@link CompressionCodec}.
- @return the type of decompressor needed by this codec.]]>
- </doc>
- </method>
- <method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new {@link Decompressor} for use by this {@link CompressionCodec}.
- @return a new decompressor for use by this codec]]>
- </doc>
- </method>
- <method name="getDefaultExtension" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[.bz2 is recognized as the default extension for compressed BZip2 files
- @return A String telling the default bzip2 file extension]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class provides output and input streams for bzip2 compression
- and decompression. It uses the native bzip2 library on the system
- if possible, else it uses a pure-Java implementation of the bzip2
- algorithm. The configuration parameter
- io.compression.codec.bzip2.library can be used to control this
- behavior.
- In the pure-Java mode, the Compressor and Decompressor interfaces
- are not implemented. Therefore, in that mode, those methods of
- CompressionCodec which have a Compressor or Decompressor type
- argument, throw UnsupportedOperationException.
- Currently, support for splittability is available only in the
- pure-Java mode; therefore, if a SplitCompressionInputStream is
- requested, the pure-Java implementation is used, regardless of the
- setting of the configuration parameter mentioned above.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.BZip2Codec -->
- <!-- start class org.apache.hadoop.io.compress.CodecPool -->
- <class name="CodecPool" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CodecPool"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get a {@link Compressor} for the given {@link CompressionCodec} from the
- pool or a new one.
- @param codec the <code>CompressionCodec</code> for which to get the
- <code>Compressor</code>
- @param conf the <code>Configuration</code> object which contains confs for creating or reinit the compressor
- @return <code>Compressor</code> for the given
- <code>CompressionCodec</code> from the pool or a new one]]>
- </doc>
- </method>
- <method name="getCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- </method>
- <method name="getDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <doc>
- <![CDATA[Get a {@link Decompressor} for the given {@link CompressionCodec} from the
- pool or a new one.
-
- @param codec the <code>CompressionCodec</code> for which to get the
- <code>Decompressor</code>
- @return <code>Decompressor</code> for the given
- <code>CompressionCodec</code> the pool or a new one]]>
- </doc>
- </method>
- <method name="returnCompressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <doc>
- <![CDATA[Return the {@link Compressor} to the pool.
-
- @param compressor the <code>Compressor</code> to be returned to the pool]]>
- </doc>
- </method>
- <method name="returnDecompressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <doc>
- <![CDATA[Return the {@link Decompressor} to the pool.
-
- @param decompressor the <code>Decompressor</code> to be returned to the
- pool]]>
- </doc>
- </method>
- <method name="getLeasedCompressorsCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <doc>
- <![CDATA[Return the number of leased {@link Compressor}s for this
- {@link CompressionCodec}]]>
- </doc>
- </method>
- <method name="getLeasedDecompressorsCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <doc>
- <![CDATA[Return the number of leased {@link Decompressor}s for this
- {@link CompressionCodec}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A global compressor/decompressor pool used to save and reuse
- (possibly native) compression/decompression codecs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.CodecPool -->
- <!-- start interface org.apache.hadoop.io.compress.CompressionCodec -->
- <interface name="CompressionCodec" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionOutputStream} that will write to the given
- {@link OutputStream}.
-
- @param out the location for the final output stream
- @return a stream the user can write uncompressed data to have it compressed
- @throws IOException]]>
- </doc>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionOutputStream} that will write to the given
- {@link OutputStream} with the given {@link Compressor}.
-
- @param out the location for the final output stream
- @param compressor compressor to use
- @return a stream the user can write uncompressed data to have it compressed
- @throws IOException]]>
- </doc>
- </method>
- <method name="getCompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type of {@link Compressor} needed by this {@link CompressionCodec}.
-
- @return the type of compressor needed by this codec.]]>
- </doc>
- </method>
- <method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new {@link Compressor} for use by this {@link CompressionCodec}.
-
- @return a new compressor for use by this codec]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionInputStream} that will read from the given
- input stream.
-
- @param in the stream to read compressed bytes from
- @return a stream to read uncompressed bytes from
- @throws IOException]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionInputStream} that will read from the given
- {@link InputStream} with the given {@link Decompressor}.
-
- @param in the stream to read compressed bytes from
- @param decompressor decompressor to use
- @return a stream to read uncompressed bytes from
- @throws IOException]]>
- </doc>
- </method>
- <method name="getDecompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type of {@link Decompressor} needed by this {@link CompressionCodec}.
-
- @return the type of decompressor needed by this codec.]]>
- </doc>
- </method>
- <method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new {@link Decompressor} for use by this {@link CompressionCodec}.
-
- @return a new decompressor for use by this codec]]>
- </doc>
- </method>
- <method name="getDefaultExtension" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default filename extension for this kind of compression.
- @return the extension including the '.']]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class encapsulates a streaming compression/decompression pair.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.CompressionCodec -->
- <!-- start class org.apache.hadoop.io.compress.CompressionCodecFactory -->
- <class name="CompressionCodecFactory" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CompressionCodecFactory" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Find the codecs specified in the config value io.compression.codecs
- and register them. Defaults to gzip and deflate.]]>
- </doc>
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Print the extension map out as a string.]]>
- </doc>
- </method>
- <method name="getCodecClasses" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the list of codecs discovered via a Java ServiceLoader, or
- listed in the configuration. Codecs specified in configuration come
- later in the returned list, and are considered to override those
- from the ServiceLoader.
- @param conf the configuration to look in
- @return a list of the {@link CompressionCodec} classes]]>
- </doc>
- </method>
- <method name="setCodecClasses"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="classes" type="java.util.List"/>
- <doc>
- <![CDATA[Sets a list of codec classes in the configuration. In addition to any
- classes specified using this method, {@link CompressionCodec} classes on
- the classpath are discovered using a Java ServiceLoader.
- @param conf the configuration to modify
- @param classes the list of classes to set]]>
- </doc>
- </method>
- <method name="getCodec" return="org.apache.hadoop.io.compress.CompressionCodec"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Find the relevant compression codec for the given file based on its
- filename suffix.
- @param file the filename to check
- @return the codec object]]>
- </doc>
- </method>
- <method name="getCodecByClassName" return="org.apache.hadoop.io.compress.CompressionCodec"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="classname" type="java.lang.String"/>
- <doc>
- <![CDATA[Find the relevant compression codec for the codec's canonical class name.
- @param classname the canonical class name of the codec
- @return the codec object]]>
- </doc>
- </method>
- <method name="getCodecByName" return="org.apache.hadoop.io.compress.CompressionCodec"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codecName" type="java.lang.String"/>
- <doc>
- <![CDATA[Find the relevant compression codec for the codec's canonical class name
- or by codec alias.
- <p/>
- Codec aliases are case insensitive.
- <p/>
- The code alias is the short class name (without the package name).
- If the short class name ends with 'Codec', then there are two aliases for
- the codec, the complete short class name and the short class name without
- the 'Codec' ending. For example for the 'GzipCodec' codec class name the
- alias are 'gzip' and 'gzipcodec'.
- @param codecName the canonical class name of the codec
- @return the codec object]]>
- </doc>
- </method>
- <method name="getCodecClassByName" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codecName" type="java.lang.String"/>
- <doc>
- <![CDATA[Find the relevant compression codec for the codec's canonical class name
- or by codec alias and returns its implemetation class.
- <p/>
- Codec aliases are case insensitive.
- <p/>
- The code alias is the short class name (without the package name).
- If the short class name ends with 'Codec', then there are two aliases for
- the codec, the complete short class name and the short class name without
- the 'Codec' ending. For example for the 'GzipCodec' codec class name the
- alias are 'gzip' and 'gzipcodec'.
- @param codecName the canonical class name of the codec
- @return the codec class]]>
- </doc>
- </method>
- <method name="removeSuffix" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="java.lang.String"/>
- <param name="suffix" type="java.lang.String"/>
- <doc>
- <![CDATA[Removes a suffix from a filename, if it has it.
- @param filename the filename to strip
- @param suffix the suffix to remove
- @return the shortened filename]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[A little test program.
- @param args]]>
- </doc>
- </method>
- <field name="LOG" type="org.slf4j.Logger"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A factory that will find the correct codec for a given filename.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.CompressionCodecFactory -->
- <!-- start class org.apache.hadoop.io.compress.CompressionInputStream -->
- <class name="CompressionInputStream" extends="java.io.InputStream"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.Seekable"/>
- <constructor name="CompressionInputStream" type="java.io.InputStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a compression input stream that reads
- the decompressed bytes from the given stream.
-
- @param in The input stream to be compressed.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read bytes from the stream.
- Made abstract to prevent leakage to underlying stream.]]>
- </doc>
- </method>
- <method name="resetState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reset the decompressor to its initial state and discard any buffered data,
- as the underlying stream may have been repositioned.]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method returns the current position in the stream.
- @return Current position in stream as a long]]>
- </doc>
- </method>
- <method name="seek"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- <doc>
- <![CDATA[This method is current not supported.
- @throws UnsupportedOperationException]]>
- </doc>
- </method>
- <method name="seekToNewSource" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="targetPos" type="long"/>
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- <doc>
- <![CDATA[This method is current not supported.
- @throws UnsupportedOperationException]]>
- </doc>
- </method>
- <field name="in" type="java.io.InputStream"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The input stream to be compressed.]]>
- </doc>
- </field>
- <field name="maxAvailableData" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A compression input stream.
- <p>Implementations are assumed to be buffered. This permits clients to
- reposition the underlying input stream then call {@link #resetState()},
- without having to also synchronize client buffers.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.CompressionInputStream -->
- <!-- start class org.apache.hadoop.io.compress.CompressionOutputStream -->
- <class name="CompressionOutputStream" extends="java.io.OutputStream"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CompressionOutputStream" type="java.io.OutputStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a compression output stream that writes
- the compressed bytes to the given stream.
- @param out]]>
- </doc>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write compressed bytes to the stream.
- Made abstract to prevent leakage to underlying stream.]]>
- </doc>
- </method>
- <method name="finish"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Finishes writing compressed data to the output stream
- without closing the underlying stream.]]>
- </doc>
- </method>
- <method name="resetState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reset the compression to the initial state.
- Does not reset the underlying stream.]]>
- </doc>
- </method>
- <field name="out" type="java.io.OutputStream"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The output stream to be compressed.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A compression output stream.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.CompressionOutputStream -->
- <!-- start interface org.apache.hadoop.io.compress.Compressor -->
- <interface name="Compressor" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Sets input data for compression.
- This should be called whenever #needsInput() returns
- <code>true</code> indicating that more input data is required.
-
- @param b Input data
- @param off Start offset
- @param len Length]]>
- </doc>
- </method>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the input data buffer is empty and
- #setInput() should be called to provide more input.
-
- @return <code>true</code> if the input data buffer is empty and
- #setInput() should be called in order to provide more input.]]>
- </doc>
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Sets preset dictionary for compression. A preset dictionary
- is used when the history buffer can be predetermined.
- @param b Dictionary data bytes
- @param off Start offset
- @param len Length]]>
- </doc>
- </method>
- <method name="getBytesRead" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return number of uncompressed bytes input so far.]]>
- </doc>
- </method>
- <method name="getBytesWritten" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return number of compressed bytes output so far.]]>
- </doc>
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[When called, indicates that compression should end
- with the current contents of the input buffer.]]>
- </doc>
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the end of the compressed
- data output stream has been reached.
- @return <code>true</code> if the end of the compressed
- data output stream has been reached.]]>
- </doc>
- </method>
- <method name="compress" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fills specified buffer with compressed data. Returns actual number
- of bytes of compressed data. A return value of 0 indicates that
- needsInput() should be called in order to determine if more input
- data is required.
-
- @param b Buffer for the compressed data
- @param off Start offset of the data
- @param len Size of the buffer
- @return The actual number of bytes of compressed data.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resets compressor so that a new set of input data can be processed.]]>
- </doc>
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Closes the compressor and discards any unprocessed input.]]>
- </doc>
- </method>
- <method name="reinit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Prepare the compressor to be used in a new stream with settings defined in
- the given Configuration
-
- @param conf Configuration from which new setting are fetched]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Specification of a stream-based 'compressor' which can be
- plugged into a {@link CompressionOutputStream} to compress data.
- This is modelled after {@link java.util.zip.Deflater}]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.Compressor -->
- <!-- start class org.apache.hadoop.io.compress.CompressorStream -->
- <class name="CompressorStream" extends="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="CompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="CompressorStream" type="java.io.OutputStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Allow derived classes to directly set the underlying stream.
-
- @param out Underlying output stream.]]>
- </doc>
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="compress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="resetState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="compressor" type="org.apache.hadoop.io.compress.Compressor"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="buffer" type="byte[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="closed" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.io.compress.CompressorStream -->
- <!-- start interface org.apache.hadoop.io.compress.Decompressor -->
- <interface name="Decompressor" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Sets input data for decompression.
- This should be called if and only if {@link #needsInput()} returns
- <code>true</code> indicating that more input data is required.
- (Both native and non-native versions of various Decompressors require
- that the data passed in via <code>b[]</code> remain unmodified until
- the caller is explicitly notified--via {@link #needsInput()}--that the
- buffer may be safely modified. With this requirement, an extra
- buffer-copy can be avoided.)
-
- @param b Input data
- @param off Start offset
- @param len Length]]>
- </doc>
- </method>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns <code>true</code> if the input data buffer is empty and
- {@link #setInput(byte[], int, int)} should be called to
- provide more input.
-
- @return <code>true</code> if the input data buffer is empty and
- {@link #setInput(byte[], int, int)} should be called in
- order to provide more input.]]>
- </doc>
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Sets preset dictionary for compression. A preset dictionary
- is used when the history buffer can be predetermined.
- @param b Dictionary data bytes
- @param off Start offset
- @param len Length]]>
- </doc>
- </method>
- <method name="needsDictionary" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns <code>true</code> if a preset dictionary is needed for decompression.
- @return <code>true</code> if a preset dictionary is needed for decompression]]>
- </doc>
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns <code>true</code> if the end of the decompressed
- data output stream has been reached. Indicates a concatenated data stream
- when finished() returns <code>true</code> and {@link #getRemaining()}
- returns a positive value. finished() will be reset with the
- {@link #reset()} method.
- @return <code>true</code> if the end of the decompressed
- data output stream has been reached.]]>
- </doc>
- </method>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fills specified buffer with uncompressed data. Returns actual number
- of bytes of uncompressed data. A return value of 0 indicates that
- {@link #needsInput()} should be called in order to determine if more
- input data is required.
-
- @param b Buffer for the compressed data
- @param off Start offset of the data
- @param len Size of the buffer
- @return The actual number of bytes of uncompressed data.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getRemaining" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of bytes remaining in the compressed data buffer.
- Indicates a concatenated data stream if {@link #finished()} returns
- <code>true</code> and getRemaining() returns a positive value. If
- {@link #finished()} returns <code>true</code> and getRemaining() returns
- a zero value, indicates that the end of data stream has been reached and
- is not a concatenated data stream.
- @return The number of bytes remaining in the compressed data buffer.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resets decompressor and input and output buffers so that a new set of
- input data can be processed. If {@link #finished()}} returns
- <code>true</code> and {@link #getRemaining()} returns a positive value,
- reset() is called before processing of the next data stream in the
- concatenated data stream. {@link #finished()} will be reset and will
- return <code>false</code> when reset() is called.]]>
- </doc>
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Closes the decompressor and discards any unprocessed input.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Specification of a stream-based 'de-compressor' which can be
- plugged into a {@link CompressionInputStream} to compress data.
- This is modelled after {@link java.util.zip.Inflater}]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.Decompressor -->
- <!-- start class org.apache.hadoop.io.compress.DecompressorStream -->
- <class name="DecompressorStream" extends="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="DecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="DecompressorStream" type="java.io.InputStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Allow derived classes to directly set the underlying stream.
-
- @param in Underlying input stream.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCompressedData" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="checkStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="resetState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="skip" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="available" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="markSupported" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="mark"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="readlimit" type="int"/>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="buffer" type="byte[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="eof" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="closed" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.io.compress.DecompressorStream -->
- <!-- start class org.apache.hadoop.io.compress.DefaultCodec -->
- <class name="DefaultCodec" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <implements name="org.apache.hadoop.io.compress.CompressionCodec"/>
- <implements name="org.apache.hadoop.io.compress.DirectDecompressionCodec"/>
- <constructor name="DefaultCodec"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getDecompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createDirectDecompressor" return="org.apache.hadoop.io.compress.DirectDecompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getDefaultExtension" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.io.compress.DefaultCodec -->
- <!-- start interface org.apache.hadoop.io.compress.DirectDecompressionCodec -->
- <interface name="DirectDecompressionCodec" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.CompressionCodec"/>
- <method name="createDirectDecompressor" return="org.apache.hadoop.io.compress.DirectDecompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new {@link DirectDecompressor} for use by this {@link DirectDecompressionCodec}.
-
- @return a new direct decompressor for use by this codec]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class encapsulates a codec which can decompress direct bytebuffers.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.DirectDecompressionCodec -->
- <!-- start interface org.apache.hadoop.io.compress.DirectDecompressor -->
- <interface name="DirectDecompressor" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="decompress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="java.nio.ByteBuffer"/>
- <param name="dst" type="java.nio.ByteBuffer"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Specification of a direct ByteBuffer 'de-compressor'.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.DirectDecompressor -->
- <!-- start class org.apache.hadoop.io.compress.GzipCodec -->
- <class name="GzipCodec" extends="org.apache.hadoop.io.compress.DefaultCodec"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GzipCodec"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getCompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDecompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createDirectDecompressor" return="org.apache.hadoop.io.compress.DirectDecompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDefaultExtension" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This class creates gzip compressors/decompressors.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.GzipCodec -->
- <!-- start class org.apache.hadoop.io.compress.SplitCompressionInputStream -->
- <class name="SplitCompressionInputStream" extends="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SplitCompressionInputStream" type="java.io.InputStream, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="setStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="start" type="long"/>
- </method>
- <method name="setEnd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="end" type="long"/>
- </method>
- <method name="getAdjustedStart" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[After calling createInputStream, the values of start or end
- might change. So this method can be used to get the new value of start.
- @return The changed value of start]]>
- </doc>
- </method>
- <method name="getAdjustedEnd" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[After calling createInputStream, the values of start or end
- might change. So this method can be used to get the new value of end.
- @return The changed value of end]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An InputStream covering a range of compressed data. The start and end
- offsets requested by a client may be modified by the codec to fit block
- boundaries or other algorithm-dependent requirements.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.SplitCompressionInputStream -->
- <!-- start interface org.apache.hadoop.io.compress.SplittableCompressionCodec -->
- <interface name="SplittableCompressionCodec" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.CompressionCodec"/>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.SplitCompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="seekableIn" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <param name="start" type="long"/>
- <param name="end" type="long"/>
- <param name="readMode" type="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a stream as dictated by the readMode. This method is used when
- the codecs wants the ability to work with the underlying stream positions.
- @param seekableIn The seekable input stream (seeks in compressed data)
- @param start The start offset into the compressed stream. May be changed
- by the underlying codec.
- @param end The end offset into the compressed stream. May be changed by
- the underlying codec.
- @param readMode Controls whether stream position is reported continuously
- from the compressed stream only only at block boundaries.
- @return a stream to read uncompressed bytes from]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This interface is meant to be implemented by those compression codecs
- which are capable to compress / de-compress a stream starting at any
- arbitrary position.
- Especially the process of de-compressing a stream starting at some arbitrary
- position is challenging. Most of the codecs are only able to successfully
- de-compress a stream, if they start from the very beginning till the end.
- One of the reasons is the stored state at the beginning of the stream which
- is crucial for de-compression.
- Yet there are few codecs which do not save the whole state at the beginning
- of the stream and hence can be used to de-compress stream starting at any
- arbitrary points. This interface is meant to be used by such codecs. Such
- codecs are highly valuable, especially in the context of Hadoop, because
- an input compressed file can be split and hence can be worked on by multiple
- machines in parallel.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.SplittableCompressionCodec -->
- </package>
- <package name="org.apache.hadoop.io.file.tfile">
- <!-- start class org.apache.hadoop.io.file.tfile.MetaBlockAlreadyExists -->
- <class name="MetaBlockAlreadyExists" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exception - Meta Block with the same name already exists.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.MetaBlockAlreadyExists -->
- <!-- start class org.apache.hadoop.io.file.tfile.MetaBlockDoesNotExist -->
- <class name="MetaBlockDoesNotExist" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exception - No such Meta Block with the given name.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.MetaBlockDoesNotExist -->
- <!-- start interface org.apache.hadoop.io.file.tfile.RawComparable -->
- <interface name="RawComparable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="buffer" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the underlying byte array.
-
- @return The underlying byte array.]]>
- </doc>
- </method>
- <method name="offset" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the offset of the first byte in the byte array.
-
- @return The offset of the first byte in the byte array.]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the size of the byte range in the byte array.
-
- @return The size of the byte range in the byte array.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface for objects that can be compared through {@link RawComparator}.
- This is useful in places where we need a single object reference to specify a
- range of bytes in a byte array, such as {@link Comparable} or
- {@link Collections#binarySearch(java.util.List, Object, Comparator)}
-
- The actual comparison among RawComparable's requires an external
- RawComparator and it is applications' responsibility to ensure two
- RawComparable are supposed to be semantically comparable with the same
- RawComparator.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.file.tfile.RawComparable -->
- <!-- start class org.apache.hadoop.io.file.tfile.TFile -->
- <class name="TFile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="makeComparator" return="java.util.Comparator"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Make a raw comparator from a string name.
-
- @param name
- Comparator name
- @return A RawComparable comparator.]]>
- </doc>
- </method>
- <method name="getSupportedCompressionAlgorithms" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get names of supported compression algorithms. The names are acceptable by
- TFile.Writer.
-
- @return Array of strings, each represents a supported compression
- algorithm. Currently, the following compression algorithms are
- supported.
- <ul>
- <li>"none" - No compression.
- <li>"lzo" - LZO compression.
- <li>"gz" - GZIP compression.
- </ul>]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Dumping the TFile information.
-
- @param args
- A list of TFile paths.]]>
- </doc>
- </method>
- <field name="COMPRESSION_GZ" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[compression: gzip]]>
- </doc>
- </field>
- <field name="COMPRESSION_LZO" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[compression: lzo]]>
- </doc>
- </field>
- <field name="COMPRESSION_NONE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[compression: none]]>
- </doc>
- </field>
- <field name="COMPARATOR_MEMCMP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[comparator: memcmp]]>
- </doc>
- </field>
- <field name="COMPARATOR_JCLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[comparator prefix: java class]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A TFile is a container of key-value pairs. Both keys and values are type-less
- bytes. Keys are restricted to 64KB, value length is not restricted
- (practically limited to the available disk storage). TFile further provides
- the following features:
- <ul>
- <li>Block Compression.
- <li>Named meta data blocks.
- <li>Sorted or unsorted keys.
- <li>Seek by key or by file offset.
- </ul>
- The memory footprint of a TFile includes the following:
- <ul>
- <li>Some constant overhead of reading or writing a compressed block.
- <ul>
- <li>Each compressed block requires one compression/decompression codec for
- I/O.
- <li>Temporary space to buffer the key.
- <li>Temporary space to buffer the value (for TFile.Writer only). Values are
- chunk encoded, so that we buffer at most one chunk of user data. By default,
- the chunk buffer is 1MB. Reading chunked value does not require additional
- memory.
- </ul>
- <li>TFile index, which is proportional to the total number of Data Blocks.
- The total amount of memory needed to hold the index can be estimated as
- (56+AvgKeySize)*NumBlocks.
- <li>MetaBlock index, which is proportional to the total number of Meta
- Blocks.The total amount of memory needed to hold the index for Meta Blocks
- can be estimated as (40+AvgMetaBlockName)*NumMetaBlock.
- </ul>
- <p>
- The behavior of TFile can be customized by the following variables through
- Configuration:
- <ul>
- <li><b>tfile.io.chunk.size</b>: Value chunk size. Integer (in bytes). Default
- to 1MB. Values of the length less than the chunk size is guaranteed to have
- known value length in read time (See
- {@link TFile.Reader.Scanner.Entry#isValueLengthKnown()}).
- <li><b>tfile.fs.output.buffer.size</b>: Buffer size used for
- FSDataOutputStream. Integer (in bytes). Default to 256KB.
- <li><b>tfile.fs.input.buffer.size</b>: Buffer size used for
- FSDataInputStream. Integer (in bytes). Default to 256KB.
- </ul>
- <p>
- Suggestions on performance optimization.
- <ul>
- <li>Minimum block size. We recommend a setting of minimum block size between
- 256KB to 1MB for general usage. Larger block size is preferred if files are
- primarily for sequential access. However, it would lead to inefficient random
- access (because there are more data to decompress). Smaller blocks are good
- for random access, but require more memory to hold the block index, and may
- be slower to create (because we must flush the compressor stream at the
- conclusion of each data block, which leads to an FS I/O flush). Further, due
- to the internal caching in Compression codec, the smallest possible block
- size would be around 20KB-30KB.
- <li>The current implementation does not offer true multi-threading for
- reading. The implementation uses FSDataInputStream seek()+read(), which is
- shown to be much faster than positioned-read call in single thread mode.
- However, it also means that if multiple threads attempt to access the same
- TFile (using multiple scanners) simultaneously, the actual I/O is carried out
- sequentially even if they access different DFS blocks.
- <li>Compression codec. Use "none" if the data is not very compressable (by
- compressable, I mean a compression ratio at least 2:1). Generally, use "lzo"
- as the starting point for experimenting. "gz" overs slightly better
- compression ratio over "lzo" but requires 4x CPU to compress and 2x CPU to
- decompress, comparing to "lzo".
- <li>File system buffering, if the underlying FSDataInputStream and
- FSDataOutputStream is already adequately buffered; or if applications
- reads/writes keys and values in large buffers, we can reduce the sizes of
- input/output buffering in TFile layer by setting the configuration parameters
- "tfile.fs.input.buffer.size" and "tfile.fs.output.buffer.size".
- </ul>
-
- Some design rationale behind TFile can be found at <a
- href=https://issues.apache.org/jira/browse/HADOOP-3315>Hadoop-3315</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.TFile -->
- <!-- start class org.apache.hadoop.io.file.tfile.Utils -->
- <class name="Utils" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="writeVInt"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="n" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Encoding an integer into a variable-length encoding format. Synonymous to
- <code>Utils#writeVLong(out, n)</code>.
-
- @param out
- output stream
- @param n
- The integer to be encoded
- @throws IOException
- @see Utils#writeVLong(DataOutput, long)]]>
- </doc>
- </method>
- <method name="writeVLong"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="n" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Encoding a Long integer into a variable-length encoding format.
- <ul>
- <li>if n in [-32, 127): encode in one byte with the actual value.
- Otherwise,
- <li>if n in [-20*2^8, 20*2^8): encode in two bytes: byte[0] = n/256 - 52;
- byte[1]=n&0xff. Otherwise,
- <li>if n IN [-16*2^16, 16*2^16): encode in three bytes: byte[0]=n/2^16 -
- 88; byte[1]=(n>>8)&0xff; byte[2]=n&0xff. Otherwise,
- <li>if n in [-8*2^24, 8*2^24): encode in four bytes: byte[0]=n/2^24 - 112;
- byte[1] = (n>>16)&0xff; byte[2] = (n>>8)&0xff; byte[3]=n&0xff. Otherwise:
- <li>if n in [-2^31, 2^31): encode in five bytes: byte[0]=-125; byte[1] =
- (n>>24)&0xff; byte[2]=(n>>16)&0xff; byte[3]=(n>>8)&0xff; byte[4]=n&0xff;
- <li>if n in [-2^39, 2^39): encode in six bytes: byte[0]=-124; byte[1] =
- (n>>32)&0xff; byte[2]=(n>>24)&0xff; byte[3]=(n>>16)&0xff;
- byte[4]=(n>>8)&0xff; byte[5]=n&0xff
- <li>if n in [-2^47, 2^47): encode in seven bytes: byte[0]=-123; byte[1] =
- (n>>40)&0xff; byte[2]=(n>>32)&0xff; byte[3]=(n>>24)&0xff;
- byte[4]=(n>>16)&0xff; byte[5]=(n>>8)&0xff; byte[6]=n&0xff;
- <li>if n in [-2^55, 2^55): encode in eight bytes: byte[0]=-122; byte[1] =
- (n>>48)&0xff; byte[2] = (n>>40)&0xff; byte[3]=(n>>32)&0xff;
- byte[4]=(n>>24)&0xff; byte[5]=(n>>16)&0xff; byte[6]=(n>>8)&0xff;
- byte[7]=n&0xff;
- <li>if n in [-2^63, 2^63): encode in nine bytes: byte[0]=-121; byte[1] =
- (n>>54)&0xff; byte[2] = (n>>48)&0xff; byte[3] = (n>>40)&0xff;
- byte[4]=(n>>32)&0xff; byte[5]=(n>>24)&0xff; byte[6]=(n>>16)&0xff;
- byte[7]=(n>>8)&0xff; byte[8]=n&0xff;
- </ul>
-
- @param out
- output stream
- @param n
- the integer number
- @throws IOException]]>
- </doc>
- </method>
- <method name="readVInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Decoding the variable-length integer. Synonymous to
- <code>(int)Utils#readVLong(in)</code>.
-
- @param in
- input stream
- @return the decoded integer
- @throws IOException
-
- @see Utils#readVLong(DataInput)]]>
- </doc>
- </method>
- <method name="readVLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Decoding the variable-length integer. Suppose the value of the first byte
- is FB, and the following bytes are NB[*].
- <ul>
- <li>if (FB >= -32), return (long)FB;
- <li>if (FB in [-72, -33]), return (FB+52)<<8 + NB[0]&0xff;
- <li>if (FB in [-104, -73]), return (FB+88)<<16 + (NB[0]&0xff)<<8 +
- NB[1]&0xff;
- <li>if (FB in [-120, -105]), return (FB+112)<<24 + (NB[0]&0xff)<<16 +
- (NB[1]&0xff)<<8 + NB[2]&0xff;
- <li>if (FB in [-128, -121]), return interpret NB[FB+129] as a signed
- big-endian integer.
-
- @param in
- input stream
- @return the decoded long integer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a String as a VInt n, followed by n Bytes as in Text format.
-
- @param out
- @param s
- @throws IOException]]>
- </doc>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a String as a VInt n, followed by n Bytes in Text format.
-
- @param in
- The input stream.
- @return The string
- @throws IOException]]>
- </doc>
- </method>
- <method name="lowerBound" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="list" type="java.util.List"/>
- <param name="key" type="T"/>
- <param name="cmp" type="java.util.Comparator"/>
- <doc>
- <![CDATA[Lower bound binary search. Find the index to the first element in the list
- that compares greater than or equal to key.
-
- @param <T>
- Type of the input key.
- @param list
- The list
- @param key
- The input key.
- @param cmp
- Comparator for the key.
- @return The index to the desired element if it exists; or list.size()
- otherwise.]]>
- </doc>
- </method>
- <method name="upperBound" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="list" type="java.util.List"/>
- <param name="key" type="T"/>
- <param name="cmp" type="java.util.Comparator"/>
- <doc>
- <![CDATA[Upper bound binary search. Find the index to the first element in the list
- that compares greater than the input key.
-
- @param <T>
- Type of the input key.
- @param list
- The list
- @param key
- The input key.
- @param cmp
- Comparator for the key.
- @return The index to the desired element if it exists; or list.size()
- otherwise.]]>
- </doc>
- </method>
- <method name="lowerBound" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="list" type="java.util.List"/>
- <param name="key" type="T"/>
- <doc>
- <![CDATA[Lower bound binary search. Find the index to the first element in the list
- that compares greater than or equal to key.
-
- @param <T>
- Type of the input key.
- @param list
- The list
- @param key
- The input key.
- @return The index to the desired element if it exists; or list.size()
- otherwise.]]>
- </doc>
- </method>
- <method name="upperBound" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="list" type="java.util.List"/>
- <param name="key" type="T"/>
- <doc>
- <![CDATA[Upper bound binary search. Find the index to the first element in the list
- that compares greater than the input key.
-
- @param <T>
- Type of the input key.
- @param list
- The list
- @param key
- The input key.
- @return The index to the desired element if it exists; or list.size()
- otherwise.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Supporting Utility classes used by TFile, and shared by users of TFile.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.Utils -->
- </package>
- <package name="org.apache.hadoop.io.serializer">
- <!-- start class org.apache.hadoop.io.serializer.JavaSerialization -->
- <class name="JavaSerialization" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.serializer.Serialization"/>
- <constructor name="JavaSerialization"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[<p>
- An experimental {@link Serialization} for Java {@link Serializable} classes.
- </p>
- @see JavaSerializationComparator]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.JavaSerialization -->
- <!-- start class org.apache.hadoop.io.serializer.JavaSerializationComparator -->
- <class name="JavaSerializationComparator" extends="org.apache.hadoop.io.serializer.DeserializerComparator"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JavaSerializationComparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <doc>
- <![CDATA[<p>
- A {@link RawComparator} that uses a {@link JavaSerialization}
- {@link Deserializer} to deserialize objects that are then compared via
- their {@link Comparable} interfaces.
- </p>
- @param <T>
- @see JavaSerialization]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.JavaSerializationComparator -->
- <!-- start class org.apache.hadoop.io.serializer.WritableSerialization -->
- <class name="WritableSerialization" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.serializer.Serialization"/>
- <constructor name="WritableSerialization"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A {@link Serialization} for {@link Writable}s that delegates to
- {@link Writable#write(java.io.DataOutput)} and
- {@link Writable#readFields(java.io.DataInput)}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.WritableSerialization -->
- <doc>
- <![CDATA[<p>
- This package provides a mechanism for using different serialization frameworks
- in Hadoop. The property "io.serializations" defines a list of
- {@link org.apache.hadoop.io.serializer.Serialization}s that know how to create
- {@link org.apache.hadoop.io.serializer.Serializer}s and
- {@link org.apache.hadoop.io.serializer.Deserializer}s.
- </p>
- <p>
- To add a new serialization framework write an implementation of
- {@link org.apache.hadoop.io.serializer.Serialization} and add its name to the
- "io.serializations" property.
- </p>]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.io.serializer.avro">
- <!-- start interface org.apache.hadoop.io.serializer.avro.AvroReflectSerializable -->
- <interface name="AvroReflectSerializable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Tag interface for Avro 'reflect' serializable classes. Classes implementing
- this interface can be serialized/deserialized using
- {@link AvroReflectSerialization}.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.serializer.avro.AvroReflectSerializable -->
- <!-- start class org.apache.hadoop.io.serializer.avro.AvroReflectSerialization -->
- <class name="AvroReflectSerialization" extends="org.apache.hadoop.io.serializer.avro.AvroSerialization"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AvroReflectSerialization"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="AVRO_REFLECT_PACKAGES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Key to configure packages that contain classes to be serialized and
- deserialized using this class. Multiple packages can be specified using
- comma-separated list.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Serialization for Avro Reflect classes. For a class to be accepted by this
- serialization, it must either be in the package list configured via
- <code>avro.reflect.pkgs</code> or implement
- {@link AvroReflectSerializable} interface.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.avro.AvroReflectSerialization -->
- <!-- start class org.apache.hadoop.io.serializer.avro.AvroSerialization -->
- <class name="AvroSerialization" extends="org.apache.hadoop.conf.Configured"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.serializer.Serialization"/>
- <constructor name="AvroSerialization"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="AVRO_SCHEMA_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Base class for providing serialization to Avro types.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.avro.AvroSerialization -->
- <!-- start class org.apache.hadoop.io.serializer.avro.AvroSpecificSerialization -->
- <class name="AvroSpecificSerialization" extends="org.apache.hadoop.io.serializer.avro.AvroSerialization"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AvroSpecificSerialization"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Serialization for Avro Specific classes. This serialization is to be used
- for classes generated by Avro's 'specific' compiler.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.avro.AvroSpecificSerialization -->
- <doc>
- <![CDATA[<p>
- This package provides Avro serialization in Hadoop. This can be used to
- serialize/deserialize Avro types in Hadoop.
- </p>
- <p>
- Use {@link org.apache.hadoop.io.serializer.avro.AvroSpecificSerialization} for
- serialization of classes generated by Avro's 'specific' compiler.
- </p>
- <p>
- Use {@link org.apache.hadoop.io.serializer.avro.AvroReflectSerialization} for
- other classes.
- {@link org.apache.hadoop.io.serializer.avro.AvroReflectSerialization} work for
- any class which is either in the package list configured via
- {@link org.apache.hadoop.io.serializer.avro.AvroReflectSerialization#AVRO_REFLECT_PACKAGES}
- or implement {@link org.apache.hadoop.io.serializer.avro.AvroReflectSerializable}
- interface.
- </p>]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.ipc.protocolPB">
- </package>
- <package name="org.apache.hadoop.log">
- </package>
- <package name="org.apache.hadoop.log.metrics">
- <!-- start class org.apache.hadoop.log.metrics.EventCounter -->
- <class name="EventCounter" extends="org.apache.log4j.AppenderSkeleton"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="EventCounter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.log4j.spi.LoggingEvent"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="requiresLayout" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A log4J Appender that simply counts logging events in three levels:
- fatal, error and warn. The class name is used in log4j.properties]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.log.metrics.EventCounter -->
- </package>
- <package name="org.apache.hadoop.metrics">
- <doc>
- <![CDATA[This package defines an API for reporting performance metric information.
- <p/>
- The API is abstract so that it can be implemented on top of
- a variety of metrics client libraries. The choice of
- client library is a configuration option, and different
- modules within the same application can use
- different metrics implementation libraries.
- <p/>
- Sub-packages:
- <dl>
- <dt><code>org.apache.hadoop.metrics.spi</code></dt>
- <dd>The abstract Server Provider Interface package. Those wishing to
- integrate the metrics API with a particular metrics client library should
- extend this package.</dd>
-
- <dt><code>org.apache.hadoop.metrics.file</code></dt>
- <dd>An implementation package which writes the metric data to
- a file, or sends it to the standard output stream.</dd>
-
- <dt> <code>org.apache.hadoop.metrics.ganglia</code></dt>
- <dd>An implementation package which sends metric data to
- <a href="http://ganglia.sourceforge.net/">Ganglia</a>.</dd>
- </dl>
- <h3>Introduction to the Metrics API</h3>
- Here is a simple example of how to use this package to report a single
- metric value:
- <pre>
- private ContextFactory contextFactory = ContextFactory.getFactory();
-
- void reportMyMetric(float myMetric) {
- MetricsContext myContext = contextFactory.getContext("myContext");
- MetricsRecord myRecord = myContext.getRecord("myRecord");
- myRecord.setMetric("myMetric", myMetric);
- myRecord.update();
- }
- </pre>
-
- In this example there are three names:
- <dl>
- <dt><i>myContext</i></dt>
- <dd>The context name will typically identify either the application, or else a
- module within an application or library.</dd>
-
- <dt><i>myRecord</i></dt>
- <dd>The record name generally identifies some entity for which a set of
- metrics are to be reported. For example, you could have a record named
- "cacheStats" for reporting a number of statistics relating to the usage of
- some cache in your application.</dd>
-
- <dt><i>myMetric</i></dt>
- <dd>This identifies a particular metric. For example, you might have metrics
- named "cache_hits" and "cache_misses".
- </dd>
- </dl>
- <h3>Tags</h3>
- In some cases it is useful to have multiple records with the same name. For
- example, suppose that you want to report statistics about each disk on a computer.
- In this case, the record name would be something like "diskStats", but you also
- need to identify the disk which is done by adding a <i>tag</i> to the record.
- The code could look something like this:
- <pre>
- private MetricsRecord diskStats =
- contextFactory.getContext("myContext").getRecord("diskStats");
-
- void reportDiskMetrics(String diskName, float diskBusy, float diskUsed) {
- diskStats.setTag("diskName", diskName);
- diskStats.setMetric("diskBusy", diskBusy);
- diskStats.setMetric("diskUsed", diskUsed);
- diskStats.update();
- }
- </pre>
- <h3>Buffering and Callbacks</h3>
- Data is not sent immediately to the metrics system when
- <code>MetricsRecord.update()</code> is called. Instead it is stored in an
- internal table, and the contents of the table are sent periodically.
- This can be important for two reasons:
- <ol>
- <li>It means that a programmer is free to put calls to this API in an
- inner loop, since updates can be very frequent without slowing down
- the application significantly.</li>
- <li>Some implementations can gain efficiency by combining many metrics
- into a single UDP message.</li>
- </ol>
- The API provides a timer-based callback via the
- <code>registerUpdater()</code> method. The benefit of this
- versus using <code>java.util.Timer</code> is that the callbacks will be done
- immediately before sending the data, making the data as current as possible.
- <h3>Configuration</h3>
- It is possible to programmatically examine and modify configuration data
- before creating a context, like this:
- <pre>
- ContextFactory factory = ContextFactory.getFactory();
- ... examine and/or modify factory attributes ...
- MetricsContext context = factory.getContext("myContext");
- </pre>
- The factory attributes can be examined and modified using the following
- <code>ContextFactory</code>methods:
- <ul>
- <li><code>Object getAttribute(String attributeName)</code></li>
- <li><code>String[] getAttributeNames()</code></li>
- <li><code>void setAttribute(String name, Object value)</code></li>
- <li><code>void removeAttribute(attributeName)</code></li>
- </ul>
- <p/>
- <code>ContextFactory.getFactory()</code> initializes the factory attributes by
- reading the properties file <code>hadoop-metrics.properties</code> if it exists
- on the class path.
- <p/>
- A factory attribute named:
- <pre>
- <i>contextName</i>.class
- </pre>
- should have as its value the fully qualified name of the class to be
- instantiated by a call of the <code>CodeFactory</code> method
- <code>getContext(<i>contextName</i>)</code>. If this factory attribute is not
- specified, the default is to instantiate
- <code>org.apache.hadoop.metrics.file.FileContext</code>.
- <p/>
- Other factory attributes are specific to a particular implementation of this
- API and are documented elsewhere. For example, configuration attributes for
- the file and Ganglia implementations can be found in the javadoc for
- their respective packages.]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.metrics.ganglia">
- <!-- start class org.apache.hadoop.metrics.ganglia.GangliaContext -->
- <class name="GangliaContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link org.apache.hadoop.metrics2.sink.ganglia.GangliaSink30}
- instead.">
- <constructor name="GangliaContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of GangliaContext]]>
- </doc>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[method to close the datagram socket]]>
- </doc>
- </method>
- <method name="emitMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="type" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getUnits" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- </method>
- <method name="getSlope" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- </method>
- <method name="getTmax" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- </method>
- <method name="getDmax" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- </method>
- <method name="xdr_string"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <doc>
- <![CDATA[Puts a string into the buffer by first writing the size of the string
- as an int, followed by the bytes of the string, padded if necessary to
- a multiple of 4.]]>
- </doc>
- </method>
- <method name="xdr_int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Puts an integer into the buffer as 4 bytes, big-endian.]]>
- </doc>
- </method>
- <field name="buffer" type="byte[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="offset" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="metricsServers" type="java.util.List"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="datagramSocket" type="java.net.DatagramSocket"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Context for sending metrics to Ganglia.
- @deprecated Use {@link org.apache.hadoop.metrics2.sink.ganglia.GangliaSink30}
- instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.ganglia.GangliaContext -->
- <doc>
- <![CDATA[<!--
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you 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.
- -->
- Implementation of the metrics package that sends metric data to
- <a href="http://ganglia.sourceforge.net/">Ganglia</a>.
- Programmers should not normally need to use this package directly. Instead
- they should use org.hadoop.metrics.
- <p/>
- These are the implementation specific factory attributes
- (See ContextFactory.getFactory()):
- <dl>
- <dt><i>contextName</i>.servers</dt>
- <dd>Space and/or comma separated sequence of servers to which UDP
- messages should be sent.</dd>
-
- <dt><i>contextName</i>.period</dt>
- <dd>The period in seconds on which the metric data is sent to the
- server(s).</dd>
- <dt><i>contextName</i>.multicast</dt>
- <dd>Enable multicast for Ganglia</dd>
- <dt><i>contextName</i>.multicast.ttl</dt>
- <dd>TTL for multicast packets</dd>
-
- <dt><i>contextName</i>.units.<i>recordName</i>.<i>metricName</i></dt>
- <dd>The units for the specified metric in the specified record.</dd>
-
- <dt><i>contextName</i>.slope.<i>recordName</i>.<i>metricName</i></dt>
- <dd>The slope for the specified metric in the specified record.</dd>
-
- <dt><i>contextName</i>.tmax.<i>recordName</i>.<i>metricName</i></dt>
- <dd>The tmax for the specified metric in the specified record.</dd>
-
- <dt><i>contextName</i>.dmax.<i>recordName</i>.<i>metricName</i></dt>
- <dd>The dmax for the specified metric in the specified record.</dd>
-
- </dl>]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.metrics.spi">
- <!-- start class org.apache.hadoop.metrics.spi.AbstractMetricsContext -->
- <class name="AbstractMetricsContext" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="Use org.apache.hadoop.metrics2 package instead.">
- <implements name="org.apache.hadoop.metrics.MetricsContext"/>
- <constructor name="AbstractMetricsContext"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of AbstractMetricsContext]]>
- </doc>
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
- <doc>
- <![CDATA[Initializes the context.]]>
- </doc>
- </method>
- <method name="getAttribute" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <doc>
- <![CDATA[Convenience method for subclasses to access factory attributes.]]>
- </doc>
- </method>
- <method name="getAttributeTable" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="tableName" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns an attribute-value map derived from the factory attributes
- by finding all factory attributes that begin with
- <i>contextName</i>.<i>tableName</i>. The returned map consists of
- those attributes with the contextName and tableName stripped off.]]>
- </doc>
- </method>
- <method name="getContextName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the context name.]]>
- </doc>
- </method>
- <method name="getContextFactory" return="org.apache.hadoop.metrics.ContextFactory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the factory by which this context was created.]]>
- </doc>
- </method>
- <method name="startMonitoring"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Starts or restarts monitoring, the emitting of metrics records.]]>
- </doc>
- </method>
- <method name="stopMonitoring"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stops monitoring. This does not free buffered data.
- @see #close()]]>
- </doc>
- </method>
- <method name="isMonitoring" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if monitoring is currently in progress.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stops monitoring and frees buffered data, returning this
- object to its initial state.]]>
- </doc>
- </method>
- <method name="createRecord" return="org.apache.hadoop.metrics.MetricsRecord"
- abstract="false" native="false" synchronized="true"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="recordName" type="java.lang.String"/>
- <doc>
- <![CDATA[Creates a new AbstractMetricsRecord instance with the given <code>recordName</code>.
- Throws an exception if the metrics implementation is configured with a fixed
- set of record names and <code>recordName</code> is not in that set.
-
- @param recordName the name of the record
- @throws MetricsException if recordName conflicts with configuration data]]>
- </doc>
- </method>
- <method name="newRecord" return="org.apache.hadoop.metrics.MetricsRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="recordName" type="java.lang.String"/>
- <doc>
- <![CDATA[Subclasses should override this if they subclass MetricsRecordImpl.
- @param recordName the name of the record
- @return newly created instance of MetricsRecordImpl or subclass]]>
- </doc>
- </method>
- <method name="registerUpdater"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updater" type="org.apache.hadoop.metrics.Updater"/>
- <doc>
- <![CDATA[Registers a callback to be called at time intervals determined by
- the configuration.
- @param updater object to be run periodically; it should update
- some metrics records]]>
- </doc>
- </method>
- <method name="unregisterUpdater"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updater" type="org.apache.hadoop.metrics.Updater"/>
- <doc>
- <![CDATA[Removes a callback, if it exists.
- @param updater object to be removed from the callback list]]>
- </doc>
- </method>
- <method name="getAllRecords" return="java.util.Map"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieves all the records managed by this MetricsContext.
- Useful for monitoring systems that are polling-based.
- @return A non-null collection of all monitoring records.]]>
- </doc>
- </method>
- <method name="emitRecord"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="recordName" type="java.lang.String"/>
- <param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Sends a record to the metrics system.]]>
- </doc>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called each period after all records have been emitted, this method does nothing.
- Subclasses may override it in order to perform some kind of flush.]]>
- </doc>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
- <doc>
- <![CDATA[Called by MetricsRecordImpl.update(). Creates or updates a row in
- the internal table of metric data.]]>
- </doc>
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
- <doc>
- <![CDATA[Called by MetricsRecordImpl.remove(). Removes all matching rows in
- the internal table of metric data. A row matches if it has the same
- tag names and values as record, but it may also have additional
- tags.]]>
- </doc>
- </method>
- <method name="getPeriod" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the timer period.]]>
- </doc>
- </method>
- <method name="setPeriod"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="period" type="int"/>
- <doc>
- <![CDATA[Sets the timer period]]>
- </doc>
- </method>
- <method name="parseAndSetPeriod"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <doc>
- <![CDATA[If a period is set in the attribute passed in, override
- the default with it.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The main class of the Service Provider Interface. This class should be
- extended in order to integrate the Metrics API with a specific metrics
- client library. <p/>
- This class implements the internal table of metric data, and the timer
- on which data is to be sent to the metrics system. Subclasses must
- override the abstract <code>emitRecord</code> method in order to transmit
- the data. <p/>
- @deprecated Use org.apache.hadoop.metrics2 package instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.AbstractMetricsContext -->
- <!-- start class org.apache.hadoop.metrics.spi.CompositeContext -->
- <class name="CompositeContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use org.apache.hadoop.metrics2 package instead.">
- <constructor name="CompositeContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[@deprecated Use org.apache.hadoop.metrics2 package instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.CompositeContext -->
- <!-- start class org.apache.hadoop.metrics.spi.MetricsRecordImpl -->
- <class name="MetricsRecordImpl" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link org.apache.hadoop.metrics2.impl.MetricsRecordImpl}
- instead.">
- <implements name="org.apache.hadoop.metrics.MetricsRecord"/>
- <constructor name="MetricsRecordImpl" type="java.lang.String, org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of FileRecord]]>
- </doc>
- </constructor>
- <method name="getRecordName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the record name.
- @return the record name]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="int"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="long"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="short"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="byte"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="removeTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <doc>
- <![CDATA[Removes any tag of the specified name.]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="int"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="long"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="short"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="byte"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="float"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="int"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="long"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="short"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="byte"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="float"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Updates the table of buffered data which is to be sent periodically.
- If the tag values match an existing row, that row is updated;
- otherwise, a new row is added.]]>
- </doc>
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Removes the row, if it exists, in the buffered data table having tags
- that equal the tags that have been set on this record.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An implementation of MetricsRecord. Keeps a back-pointer to the context
- from which it was created, and delegates back to it on <code>update</code>
- and <code>remove()</code>.
- @deprecated Use {@link org.apache.hadoop.metrics2.impl.MetricsRecordImpl}
- instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.MetricsRecordImpl -->
- <!-- start class org.apache.hadoop.metrics.spi.MetricValue -->
- <class name="MetricValue" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricValue" type="java.lang.Number, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of MetricValue]]>
- </doc>
- </constructor>
- <method name="isIncrement" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isAbsolute" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumber" return="java.lang.Number"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="ABSOLUTE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="INCREMENT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A Number that is either an absolute or an incremental amount.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.MetricValue -->
- <!-- start class org.apache.hadoop.metrics.spi.NoEmitMetricsContext -->
- <class name="NoEmitMetricsContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use org.apache.hadoop.metrics2 package instead.">
- <constructor name="NoEmitMetricsContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of NullContextWithUpdateThread]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[A MetricsContext that does not emit data, but, unlike NullContextWithUpdate,
- does save it for retrieval with getAllRecords().
-
- This is useful if you want to support {@link MetricsServlet}, but
- not emit metrics in any other way.
- @deprecated Use org.apache.hadoop.metrics2 package instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.NoEmitMetricsContext -->
- <!-- start class org.apache.hadoop.metrics.spi.NullContext -->
- <class name="NullContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use org.apache.hadoop.metrics2 package instead.">
- <constructor name="NullContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of NullContext]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Null metrics context: a metrics context which does nothing. Used as the
- default context, so that no performance data is emitted if no configuration
- data is found.
-
- @deprecated Use org.apache.hadoop.metrics2 package instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.NullContext -->
- <!-- start class org.apache.hadoop.metrics.spi.NullContextWithUpdateThread -->
- <class name="NullContextWithUpdateThread" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use org.apache.hadoop.metrics2 package instead.">
- <constructor name="NullContextWithUpdateThread"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of NullContextWithUpdateThread]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[A null context which has a thread calling
- periodically when monitoring is started. This keeps the data sampled
- correctly.
- In all other respects, this is like the NULL context: No data is emitted.
- This is suitable for Monitoring systems like JMX which reads the metrics
- when someone reads the data from JMX.
-
- The default impl of start and stop monitoring:
- is the AbstractMetricsContext is good enough.
-
- @deprecated Use org.apache.hadoop.metrics2 package instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.NullContextWithUpdateThread -->
- <!-- start class org.apache.hadoop.metrics.spi.OutputRecord -->
- <class name="OutputRecord" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use org.apache.hadoop.metrics2 package instead.">
- <method name="getTagNames" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the set of tag names]]>
- </doc>
- </method>
- <method name="getTag" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns a tag object which is can be a String, Integer, Short or Byte.
- @return the tag value, or null if there is no such tag]]>
- </doc>
- </method>
- <method name="getMetricNames" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the set of metric names.]]>
- </doc>
- </method>
- <method name="getMetric" return="java.lang.Number"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns the metric object which can be a Float, Integer, Short or Byte.]]>
- </doc>
- </method>
- <method name="getTagsCopy" return="org.apache.hadoop.metrics.spi.AbstractMetricsContext.TagMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a copy of this record's tags.]]>
- </doc>
- </method>
- <method name="getMetricsCopy" return="org.apache.hadoop.metrics.spi.AbstractMetricsContext.MetricMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a copy of this record's metrics.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Represents a record of metric data to be sent to a metrics system.
- @deprecated Use org.apache.hadoop.metrics2 package instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.OutputRecord -->
- <!-- start class org.apache.hadoop.metrics.spi.Util -->
- <class name="Util" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use org.apache.hadoop.metrics2 package instead.">
- <method name="parse" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="specs" type="java.lang.String"/>
- <param name="defaultPort" type="int"/>
- <doc>
- <![CDATA[Parses a space and/or comma separated sequence of server specifications
- of the form <i>hostname</i> or <i>hostname:port</i>. If
- the specs string is null, defaults to localhost:defaultPort.
-
- @return a list of InetSocketAddress objects.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Static utility methods
- @deprecated Use org.apache.hadoop.metrics2 package instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.Util -->
- <doc>
- <![CDATA[The Service Provider Interface for the Metrics API. This package provides
- an interface allowing a variety of metrics reporting implementations to be
- plugged in to the Metrics API. Examples of such implementations can be found
- in the packages <code>org.apache.hadoop.metrics.file</code> and
- <code>org.apache.hadoop.metrics.ganglia</code>.<p/>
- Plugging in an implementation involves writing a concrete subclass of
- <code>AbstractMetricsContext</code>. The subclass should get its
- configuration information using the <code>getAttribute(<i>attributeName</i>)</code>
- method.]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.metrics2">
- <!-- start class org.apache.hadoop.metrics2.AbstractMetric -->
- <class name="AbstractMetric" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsInfo"/>
- <constructor name="AbstractMetric" type="org.apache.hadoop.metrics2.MetricsInfo"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the metric
- @param info about the metric]]>
- </doc>
- </constructor>
- <method name="name" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="description" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="info" return="org.apache.hadoop.metrics2.MetricsInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="value" return="java.lang.Number"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the value of the metric
- @return the value of the metric]]>
- </doc>
- </method>
- <method name="type" return="org.apache.hadoop.metrics2.MetricType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type of the metric
- @return the type of the metric]]>
- </doc>
- </method>
- <method name="visit"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="visitor" type="org.apache.hadoop.metrics2.MetricsVisitor"/>
- <doc>
- <![CDATA[Accept a visitor interface
- @param visitor of the metric]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[The immutable metric]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.AbstractMetric -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsCollector -->
- <interface name="MetricsCollector" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="addRecord" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a metrics record
- @param name of the record
- @return a metrics record builder for the record]]>
- </doc>
- </method>
- <method name="addRecord" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <doc>
- <![CDATA[Add a metrics record
- @param info of the record
- @return a metrics record builder for the record]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics collector interface]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsCollector -->
- <!-- start class org.apache.hadoop.metrics2.MetricsException -->
- <class name="MetricsException" extends="java.lang.RuntimeException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the exception with a message
- @param message for the exception]]>
- </doc>
- </constructor>
- <constructor name="MetricsException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the exception with a message and a cause
- @param message for the exception
- @param cause of the exception]]>
- </doc>
- </constructor>
- <constructor name="MetricsException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the exception with a cause
- @param cause of the exception]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[A general metrics exception wrapper]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsException -->
- <!-- start class org.apache.hadoop.metrics2.MetricsFilter -->
- <class name="MetricsFilter" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsPlugin"/>
- <constructor name="MetricsFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="accepts" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Whether to accept the name
- @param name to filter on
- @return true to accept; false otherwise.]]>
- </doc>
- </method>
- <method name="accepts" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="org.apache.hadoop.metrics2.MetricsTag"/>
- <doc>
- <![CDATA[Whether to accept the tag
- @param tag to filter on
- @return true to accept; false otherwise]]>
- </doc>
- </method>
- <method name="accepts" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tags" type="java.lang.Iterable"/>
- <doc>
- <![CDATA[Whether to accept the tags
- @param tags to filter on
- @return true to accept; false otherwise]]>
- </doc>
- </method>
- <method name="accepts" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- <doc>
- <![CDATA[Whether to accept the record
- @param record to filter on
- @return true to accept; false otherwise.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics filter interface]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsFilter -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsInfo -->
- <interface name="MetricsInfo" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="name" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the name of the metric/tag]]>
- </doc>
- </method>
- <method name="description" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the description of the metric/tag]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface to provide immutable meta info for metrics]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsInfo -->
- <!-- start class org.apache.hadoop.metrics2.MetricsJsonBuilder -->
- <class name="MetricsJsonBuilder" extends="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsJsonBuilder" type="org.apache.hadoop.metrics2.MetricsCollector"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Build an instance.
- @param parent parent collector. Unused in this instance; only used for
- the {@link #parent()} method]]>
- </doc>
- </constructor>
- <method name="tag" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="java.lang.String"/>
- </method>
- <method name="add" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="org.apache.hadoop.metrics2.MetricsTag"/>
- </method>
- <method name="add" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.metrics2.AbstractMetric"/>
- </method>
- <method name="setContext" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.String"/>
- </method>
- <method name="addCounter" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="int"/>
- </method>
- <method name="addCounter" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="long"/>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="int"/>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="long"/>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="float"/>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="double"/>
- </method>
- <method name="parent" return="org.apache.hadoop.metrics2.MetricsCollector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="LOG" type="org.slf4j.Logger"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Build a JSON dump of the metrics.
- The {@link #toString()} operator dumps out all values collected.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsJsonBuilder -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsPlugin -->
- <interface name="MetricsPlugin" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.commons.configuration.SubsetConfiguration"/>
- <doc>
- <![CDATA[Initialize the plugin
- @param conf the configuration object for the plugin]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The plugin interface for the metrics framework]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsPlugin -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsRecord -->
- <interface name="MetricsRecord" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="timestamp" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the timestamp of the metrics
- @return the timestamp]]>
- </doc>
- </method>
- <method name="name" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the record name]]>
- </doc>
- </method>
- <method name="description" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the description of the record]]>
- </doc>
- </method>
- <method name="context" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the context name of the record]]>
- </doc>
- </method>
- <method name="tags" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the tags of the record
- Note: returning a collection instead of iterable as we
- need to use tags as keys (hence Collection#hashCode etc.) in maps
- @return an unmodifiable collection of tags]]>
- </doc>
- </method>
- <method name="metrics" return="java.lang.Iterable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the metrics of the record
- @return an immutable iterable interface for metrics]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An immutable snapshot of metrics with a timestamp]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsRecord -->
- <!-- start class org.apache.hadoop.metrics2.MetricsRecordBuilder -->
- <class name="MetricsRecordBuilder" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsRecordBuilder"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="tag" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a metrics tag
- @param info metadata of the tag
- @param value of the tag
- @return self]]>
- </doc>
- </method>
- <method name="add" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="org.apache.hadoop.metrics2.MetricsTag"/>
- <doc>
- <![CDATA[Add an immutable metrics tag object
- @param tag a pre-made tag object (potentially save an object construction)
- @return self]]>
- </doc>
- </method>
- <method name="add" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.metrics2.AbstractMetric"/>
- <doc>
- <![CDATA[Add a pre-made immutable metric object
- @param metric the pre-made metric to save an object construction
- @return self]]>
- </doc>
- </method>
- <method name="setContext" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the context tag
- @param value of the context
- @return self]]>
- </doc>
- </method>
- <method name="addCounter" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Add an integer metric
- @param info metadata of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="addCounter" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Add an long metric
- @param info metadata of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Add a integer gauge metric
- @param info metadata of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Add a long gauge metric
- @param info metadata of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="float"/>
- <doc>
- <![CDATA[Add a float gauge metric
- @param info metadata of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="double"/>
- <doc>
- <![CDATA[Add a double gauge metric
- @param info metadata of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="parent" return="org.apache.hadoop.metrics2.MetricsCollector"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the parent metrics collector object]]>
- </doc>
- </method>
- <method name="endRecord" return="org.apache.hadoop.metrics2.MetricsCollector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Syntactic sugar to add multiple records in a collector in a one liner.
- @return the parent metrics collector object]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics record builder interface]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsRecordBuilder -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsSink -->
- <interface name="MetricsSink" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsPlugin"/>
- <method name="putMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- <doc>
- <![CDATA[Put a metrics record in the sink
- @param record the record to put]]>
- </doc>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Flush any buffered metrics]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics sink interface. <p>
- Implementations of this interface consume the {@link MetricsRecord} generated
- from {@link MetricsSource}. It registers with {@link MetricsSystem} which
- periodically pushes the {@link MetricsRecord} to the sink using
- {@link #putMetrics(MetricsRecord)} method. If the implementing class also
- implements {@link Closeable}, then the MetricsSystem will close the sink when
- it is stopped.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsSink -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsSource -->
- <interface name="MetricsSource" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="collector" type="org.apache.hadoop.metrics2.MetricsCollector"/>
- <param name="all" type="boolean"/>
- <doc>
- <![CDATA[Get metrics from the source
- @param collector to contain the resulting metrics snapshot
- @param all if true, return all metrics even if unchanged.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics source interface]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsSource -->
- <!-- start class org.apache.hadoop.metrics2.MetricsSystem -->
- <class name="MetricsSystem" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSystemMXBean"/>
- <constructor name="MetricsSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="unregisterSource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Unregister a metrics source
- @param name of the source. This is the name you use to call register()]]>
- </doc>
- </method>
- <method name="register" return="T"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="source" type="T"/>
- <doc>
- <![CDATA[Register a metrics source (deriving name and description from the object)
- @param <T> the actual type of the source object
- @param source object to register
- @return the source object
- @exception MetricsException]]>
- </doc>
- </method>
- <method name="register" return="T"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="source" type="T"/>
- <doc>
- <![CDATA[Register a metrics source
- @param <T> the actual type of the source object
- @param source object to register
- @param name of the source. Must be unique or null (then extracted from
- the annotations of the source object.)
- @param desc the description of the source (or null. See above.)
- @return the source object
- @exception MetricsException]]>
- </doc>
- </method>
- <method name="register"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="callback" type="org.apache.hadoop.metrics2.MetricsSystem.Callback"/>
- <doc>
- <![CDATA[Register a callback interface for JMX events
- @param callback the callback object implementing the MBean interface.]]>
- </doc>
- </method>
- <method name="publishMetricsNow"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Requests an immediate publish of all metrics from sources to sinks.
-
- This is a "soft" request: the expectation is that a best effort will be
- done to synchronously snapshot the metrics from all the sources and put
- them in all the sinks (including flushing the sinks) before returning to
- the caller. If this can't be accomplished in reasonable time it's OK to
- return to the caller before everything is done.]]>
- </doc>
- </method>
- <method name="shutdown" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Shutdown the metrics system completely (usually during server shutdown.)
- The MetricsSystemMXBean will be unregistered.
- @return true if shutdown completed]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics system interface]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsSystem -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsSystemMXBean -->
- <interface name="MetricsSystemMXBean" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="start"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Start the metrics system
- @throws MetricsException]]>
- </doc>
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stop the metrics system
- @throws MetricsException]]>
- </doc>
- </method>
- <method name="startMetricsMBeans"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Start metrics MBeans
- @throws MetricsException]]>
- </doc>
- </method>
- <method name="stopMetricsMBeans"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stop metrics MBeans.
- Note, it doesn't stop the metrics system control MBean,
- i.e this interface.
- @throws MetricsException]]>
- </doc>
- </method>
- <method name="currentConfig" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the current config
- Avoided getConfig, as it'll turn into a "Config" attribute,
- which doesn't support multiple line values in jconsole.
- @throws MetricsException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The JMX interface to the metrics system]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsSystemMXBean -->
- <!-- start class org.apache.hadoop.metrics2.MetricsTag -->
- <class name="MetricsTag" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsInfo"/>
- <constructor name="MetricsTag" type="org.apache.hadoop.metrics2.MetricsInfo, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the tag with name, description and value
- @param info of the tag
- @param value of the tag]]>
- </doc>
- </constructor>
- <method name="name" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="description" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="info" return="org.apache.hadoop.metrics2.MetricsInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the info object of the tag]]>
- </doc>
- </method>
- <method name="value" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the value of the tag
- @return the value]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Immutable tag for metrics (for grouping on host/queue/username etc.)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsTag -->
- <!-- start class org.apache.hadoop.metrics2.MetricStringBuilder -->
- <class name="MetricStringBuilder" extends="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricStringBuilder" type="org.apache.hadoop.metrics2.MetricsCollector, java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Build an instance.
- @param parent parent collector. Unused in this instance; only used for
- the {@link #parent()} method
- @param prefix string before each entry
- @param separator separator between name and value
- @param suffix suffix after each entry]]>
- </doc>
- </constructor>
- <method name="add" return="org.apache.hadoop.metrics2.MetricStringBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="java.lang.Object"/>
- </method>
- <method name="tuple" return="org.apache.hadoop.metrics2.MetricStringBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Add any key,val pair to the string, between the prefix and suffix,
- separated by the separator.
- @param key key
- @param value value
- @return this instance]]>
- </doc>
- </method>
- <method name="tag" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="java.lang.String"/>
- </method>
- <method name="add" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="org.apache.hadoop.metrics2.MetricsTag"/>
- </method>
- <method name="add" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.metrics2.AbstractMetric"/>
- </method>
- <method name="setContext" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.String"/>
- </method>
- <method name="addCounter" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="int"/>
- </method>
- <method name="addCounter" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="long"/>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="int"/>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="long"/>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="float"/>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="double"/>
- </method>
- <method name="parent" return="org.apache.hadoop.metrics2.MetricsCollector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Build a string dump of the metrics.
- The {@link #toString()} operator dumps out all values collected.
- Every entry is formatted as
- {@code prefix + name + separator + value + suffix}]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricStringBuilder -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsVisitor -->
- <interface name="MetricsVisitor" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="gauge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Callback for integer value gauges
- @param info the metric info
- @param value of the metric]]>
- </doc>
- </method>
- <method name="gauge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Callback for long value gauges
- @param info the metric info
- @param value of the metric]]>
- </doc>
- </method>
- <method name="gauge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="float"/>
- <doc>
- <![CDATA[Callback for float value gauges
- @param info the metric info
- @param value of the metric]]>
- </doc>
- </method>
- <method name="gauge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="double"/>
- <doc>
- <![CDATA[Callback for double value gauges
- @param info the metric info
- @param value of the metric]]>
- </doc>
- </method>
- <method name="counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Callback for integer value counters
- @param info the metric info
- @param value of the metric]]>
- </doc>
- </method>
- <method name="counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Callback for long value counters
- @param info the metric info
- @param value of the metric]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A visitor interface for metrics]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsVisitor -->
- </package>
- <package name="org.apache.hadoop.metrics2.annotation">
- <!-- start class org.apache.hadoop.metrics2.annotation.Metric -->
- <class name="Metric" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <doc>
- <![CDATA[Annotation interface for a single metric]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.annotation.Metric -->
- <!-- start class org.apache.hadoop.metrics2.annotation.Metrics -->
- <class name="Metrics" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <doc>
- <![CDATA[Annotation interface for a group of metrics]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.annotation.Metrics -->
- </package>
- <package name="org.apache.hadoop.metrics2.filter">
- <!-- start class org.apache.hadoop.metrics2.filter.GlobFilter -->
- <class name="GlobFilter" extends="org.apache.hadoop.metrics2.filter.AbstractPatternFilter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GlobFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compile" return="java.util.regex.Pattern"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[A glob pattern filter for metrics.
- The class name is used in metrics config files]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.filter.GlobFilter -->
- <!-- start class org.apache.hadoop.metrics2.filter.RegexFilter -->
- <class name="RegexFilter" extends="org.apache.hadoop.metrics2.filter.AbstractPatternFilter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RegexFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compile" return="java.util.regex.Pattern"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[A regex pattern filter for metrics]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.filter.RegexFilter -->
- </package>
- <package name="org.apache.hadoop.metrics2.lib">
- <!-- start class org.apache.hadoop.metrics2.lib.DefaultMetricsSystem -->
- <class name="DefaultMetricsSystem" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.metrics2.lib.DefaultMetricsSystem[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.metrics2.lib.DefaultMetricsSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="initialize" return="org.apache.hadoop.metrics2.MetricsSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="prefix" type="java.lang.String"/>
- <doc>
- <![CDATA[Convenience method to initialize the metrics system
- @param prefix for the metrics system configuration
- @return the metrics system instance]]>
- </doc>
- </method>
- <method name="instance" return="org.apache.hadoop.metrics2.MetricsSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the metrics system object]]>
- </doc>
- </method>
- <method name="shutdown"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Shutdown the metrics system]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The default metrics system singleton]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.DefaultMetricsSystem -->
- <!-- start class org.apache.hadoop.metrics2.lib.Interns -->
- <class name="Interns" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Interns"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="info" return="org.apache.hadoop.metrics2.MetricsInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <doc>
- <![CDATA[Get a metric info object.
- @param name Name of metric info object
- @param description Description of metric info object
- @return an interned metric info object]]>
- </doc>
- </method>
- <method name="tag" return="org.apache.hadoop.metrics2.MetricsTag"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Get a metrics tag.
- @param info of the tag
- @param value of the tag
- @return an interned metrics tag]]>
- </doc>
- </method>
- <method name="tag" return="org.apache.hadoop.metrics2.MetricsTag"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Get a metrics tag.
- @param name of the tag
- @param description of the tag
- @param value of the tag
- @return an interned metrics tag]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Helpers to create interned metrics info.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.Interns -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricsRegistry -->
- <class name="MetricsRegistry" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsRegistry" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the registry with a record name
- @param name of the record of the metrics]]>
- </doc>
- </constructor>
- <constructor name="MetricsRegistry" type="org.apache.hadoop.metrics2.MetricsInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the registry with a metadata object
- @param info the info object for the metrics record/group]]>
- </doc>
- </constructor>
- <method name="info" return="org.apache.hadoop.metrics2.MetricsInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the info object of the metrics registry]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.metrics2.lib.MutableMetric"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get a metric by name
- @param name of the metric
- @return the metric object]]>
- </doc>
- </method>
- <method name="getTag" return="org.apache.hadoop.metrics2.MetricsTag"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get a tag by name
- @param name of the tag
- @return the tag object]]>
- </doc>
- </method>
- <method name="newCounter" return="org.apache.hadoop.metrics2.lib.MutableCounterInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="iVal" type="int"/>
- <doc>
- <![CDATA[Create a mutable integer counter
- @param name of the metric
- @param desc metric description
- @param iVal initial value
- @return a new counter object]]>
- </doc>
- </method>
- <method name="newCounter" return="org.apache.hadoop.metrics2.lib.MutableCounterInt"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="iVal" type="int"/>
- <doc>
- <![CDATA[Create a mutable integer counter
- @param info metadata of the metric
- @param iVal initial value
- @return a new counter object]]>
- </doc>
- </method>
- <method name="newCounter" return="org.apache.hadoop.metrics2.lib.MutableCounterLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="iVal" type="long"/>
- <doc>
- <![CDATA[Create a mutable long integer counter
- @param name of the metric
- @param desc metric description
- @param iVal initial value
- @return a new counter object]]>
- </doc>
- </method>
- <method name="newCounter" return="org.apache.hadoop.metrics2.lib.MutableCounterLong"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="iVal" type="long"/>
- <doc>
- <![CDATA[Create a mutable long integer counter
- @param info metadata of the metric
- @param iVal initial value
- @return a new counter object]]>
- </doc>
- </method>
- <method name="newGauge" return="org.apache.hadoop.metrics2.lib.MutableGaugeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="iVal" type="int"/>
- <doc>
- <![CDATA[Create a mutable integer gauge
- @param name of the metric
- @param desc metric description
- @param iVal initial value
- @return a new gauge object]]>
- </doc>
- </method>
- <method name="newGauge" return="org.apache.hadoop.metrics2.lib.MutableGaugeInt"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="iVal" type="int"/>
- <doc>
- <![CDATA[Create a mutable integer gauge
- @param info metadata of the metric
- @param iVal initial value
- @return a new gauge object]]>
- </doc>
- </method>
- <method name="newGauge" return="org.apache.hadoop.metrics2.lib.MutableGaugeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="iVal" type="long"/>
- <doc>
- <![CDATA[Create a mutable long integer gauge
- @param name of the metric
- @param desc metric description
- @param iVal initial value
- @return a new gauge object]]>
- </doc>
- </method>
- <method name="newGauge" return="org.apache.hadoop.metrics2.lib.MutableGaugeLong"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="iVal" type="long"/>
- <doc>
- <![CDATA[Create a mutable long integer gauge
- @param info metadata of the metric
- @param iVal initial value
- @return a new gauge object]]>
- </doc>
- </method>
- <method name="newGauge" return="org.apache.hadoop.metrics2.lib.MutableGaugeFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="iVal" type="float"/>
- <doc>
- <![CDATA[Create a mutable float gauge
- @param name of the metric
- @param desc metric description
- @param iVal initial value
- @return a new gauge object]]>
- </doc>
- </method>
- <method name="newGauge" return="org.apache.hadoop.metrics2.lib.MutableGaugeFloat"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="iVal" type="float"/>
- <doc>
- <![CDATA[Create a mutable float gauge
- @param info metadata of the metric
- @param iVal initial value
- @return a new gauge object]]>
- </doc>
- </method>
- <method name="newQuantiles" return="org.apache.hadoop.metrics2.lib.MutableQuantiles"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="sampleName" type="java.lang.String"/>
- <param name="valueName" type="java.lang.String"/>
- <param name="interval" type="int"/>
- <doc>
- <![CDATA[Create a mutable metric that estimates quantiles of a stream of values
- @param name of the metric
- @param desc metric description
- @param sampleName of the metric (e.g., "Ops")
- @param valueName of the metric (e.g., "Time" or "Latency")
- @param interval rollover interval of estimator in seconds
- @return a new quantile estimator object
- @throws MetricsException if interval is not a positive integer]]>
- </doc>
- </method>
- <method name="newStat" return="org.apache.hadoop.metrics2.lib.MutableStat"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="sampleName" type="java.lang.String"/>
- <param name="valueName" type="java.lang.String"/>
- <param name="extended" type="boolean"/>
- <doc>
- <![CDATA[Create a mutable metric with stats
- @param name of the metric
- @param desc metric description
- @param sampleName of the metric (e.g., "Ops")
- @param valueName of the metric (e.g., "Time" or "Latency")
- @param extended produce extended stat (stdev, min/max etc.) if true.
- @return a new mutable stat metric object]]>
- </doc>
- </method>
- <method name="newStat" return="org.apache.hadoop.metrics2.lib.MutableStat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="sampleName" type="java.lang.String"/>
- <param name="valueName" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a mutable metric with stats
- @param name of the metric
- @param desc metric description
- @param sampleName of the metric (e.g., "Ops")
- @param valueName of the metric (e.g., "Time" or "Latency")
- @return a new mutable metric object]]>
- </doc>
- </method>
- <method name="newRate" return="org.apache.hadoop.metrics2.lib.MutableRate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a mutable rate metric
- @param name of the metric
- @return a new mutable metric object]]>
- </doc>
- </method>
- <method name="newRate" return="org.apache.hadoop.metrics2.lib.MutableRate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a mutable rate metric
- @param name of the metric
- @param description of the metric
- @return a new mutable rate metric object]]>
- </doc>
- </method>
- <method name="newRate" return="org.apache.hadoop.metrics2.lib.MutableRate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="extended" type="boolean"/>
- <doc>
- <![CDATA[Create a mutable rate metric (for throughput measurement)
- @param name of the metric
- @param desc description
- @param extended produce extended stat (stdev/min/max etc.) if true
- @return a new mutable rate metric object]]>
- </doc>
- </method>
- <method name="newRatesWithAggregation" return="org.apache.hadoop.metrics2.lib.MutableRatesWithAggregation"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="newMutableRollingAverages" return="org.apache.hadoop.metrics2.lib.MutableRollingAverages"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="valueName" type="java.lang.String"/>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Add sample to a stat metric by name.
- @param name of the metric
- @param value of the snapshot to add]]>
- </doc>
- </method>
- <method name="setContext" return="org.apache.hadoop.metrics2.lib.MetricsRegistry"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the metrics context tag
- @param name of the context
- @return the registry itself as a convenience]]>
- </doc>
- </method>
- <method name="tag" return="org.apache.hadoop.metrics2.lib.MetricsRegistry"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a tag to the metrics
- @param name of the tag
- @param description of the tag
- @param value of the tag
- @return the registry (for keep adding tags)]]>
- </doc>
- </method>
- <method name="tag" return="org.apache.hadoop.metrics2.lib.MetricsRegistry"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <param name="override" type="boolean"/>
- <doc>
- <![CDATA[Add a tag to the metrics
- @param name of the tag
- @param description of the tag
- @param value of the tag
- @param override existing tag if true
- @return the registry (for keep adding tags)]]>
- </doc>
- </method>
- <method name="tag" return="org.apache.hadoop.metrics2.lib.MetricsRegistry"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="java.lang.String"/>
- <param name="override" type="boolean"/>
- <doc>
- <![CDATA[Add a tag to the metrics
- @param info metadata of the tag
- @param value of the tag
- @param override existing tag if true
- @return the registry (for keep adding tags etc.)]]>
- </doc>
- </method>
- <method name="tag" return="org.apache.hadoop.metrics2.lib.MetricsRegistry"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="org.apache.hadoop.metrics2.MetricsInfo"/>
- <param name="value" type="java.lang.String"/>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- <doc>
- <![CDATA[Sample all the mutable metrics and put the snapshot in the builder
- @param builder to contain the metrics snapshot
- @param all get all the metrics even if the values are not changed.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[An optional metrics registry class for creating and maintaining a
- collection of MetricsMutables, making writing metrics source easier.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricsRegistry -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableCounter -->
- <class name="MutableCounter" extends="org.apache.hadoop.metrics2.lib.MutableMetric"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MutableCounter" type="org.apache.hadoop.metrics2.MetricsInfo"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="info" return="org.apache.hadoop.metrics2.MetricsInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Increment the metric value by 1.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The mutable counter (monotonically increasing) metric interface]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableCounter -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableCounterInt -->
- <class name="MutableCounterInt" extends="org.apache.hadoop.metrics2.lib.MutableCounter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="int"/>
- <doc>
- <![CDATA[Increment the value by a delta
- @param delta of the increment]]>
- </doc>
- </method>
- <method name="value" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <doc>
- <![CDATA[A mutable int counter for implementing metrics sources]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableCounterInt -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableCounterLong -->
- <class name="MutableCounterLong" extends="org.apache.hadoop.metrics2.lib.MutableCounter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MutableCounterLong" type="org.apache.hadoop.metrics2.MetricsInfo, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="long"/>
- <doc>
- <![CDATA[Increment the value by a delta
- @param delta of the increment]]>
- </doc>
- </method>
- <method name="value" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <doc>
- <![CDATA[A mutable long counter]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableCounterLong -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableGauge -->
- <class name="MutableGauge" extends="org.apache.hadoop.metrics2.lib.MutableMetric"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MutableGauge" type="org.apache.hadoop.metrics2.MetricsInfo"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="info" return="org.apache.hadoop.metrics2.MetricsInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Increment the value of the metric by 1]]>
- </doc>
- </method>
- <method name="decr"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Decrement the value of the metric by 1]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The mutable gauge metric interface]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableGauge -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableGaugeInt -->
- <class name="MutableGaugeInt" extends="org.apache.hadoop.metrics2.lib.MutableGauge"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="value" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="int"/>
- <doc>
- <![CDATA[Increment by delta
- @param delta of the increment]]>
- </doc>
- </method>
- <method name="decr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="decr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="int"/>
- <doc>
- <![CDATA[decrement by delta
- @param delta of the decrement]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Set the value of the metric
- @param value to set]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <doc>
- <![CDATA[A mutable int gauge]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableGaugeInt -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableGaugeLong -->
- <class name="MutableGaugeLong" extends="org.apache.hadoop.metrics2.lib.MutableGauge"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="value" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="long"/>
- <doc>
- <![CDATA[Increment by delta
- @param delta of the increment]]>
- </doc>
- </method>
- <method name="decr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="decr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="long"/>
- <doc>
- <![CDATA[decrement by delta
- @param delta of the decrement]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Set the value of the metric
- @param value to set]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <doc>
- <![CDATA[A mutable long gauge]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableGaugeLong -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableMetric -->
- <class name="MutableMetric" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MutableMetric"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="snapshot"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- <doc>
- <![CDATA[Get a snapshot of the metric
- @param builder the metrics record builder
- @param all if true, snapshot unchanged metrics as well]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <doc>
- <![CDATA[Get a snapshot of metric if changed
- @param builder the metrics record builder]]>
- </doc>
- </method>
- <method name="setChanged"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Set the changed flag in mutable operations]]>
- </doc>
- </method>
- <method name="clearChanged"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clear the changed flag in the snapshot operations]]>
- </doc>
- </method>
- <method name="changed" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if metric is changed since last snapshot/snapshot]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The mutable metric interface]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableMetric -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableQuantiles -->
- <class name="MutableQuantiles" extends="org.apache.hadoop.metrics2.lib.MutableMetric"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MutableQuantiles" type="java.lang.String, java.lang.String, java.lang.String, java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Instantiates a new {@link MutableQuantiles} for a metric that rolls itself
- over on the specified time interval.
-
- @param name
- of the metric
- @param description
- long-form textual description of the metric
- @param sampleName
- type of items in the stream (e.g., "Ops")
- @param valueName
- type of the values
- @param interval
- rollover interval (in seconds) of the estimator]]>
- </doc>
- </constructor>
- <method name="snapshot"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- </method>
- <method name="getInterval" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getEstimator" return="org.apache.hadoop.metrics2.util.QuantileEstimator"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the quantile estimator.
- @return the quantile estimator]]>
- </doc>
- </method>
- <method name="setEstimator"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="quantileEstimator" type="org.apache.hadoop.metrics2.util.QuantileEstimator"/>
- </method>
- <field name="quantiles" type="org.apache.hadoop.metrics2.util.Quantile[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="previousSnapshot" type="java.util.Map"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Watches a stream of long values, maintaining online estimates of specific
- quantiles with provably low error bounds. This is particularly useful for
- accurate high-percentile (e.g. 95th, 99th) latency metrics.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableQuantiles -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableRate -->
- <class name="MutableRate" extends="org.apache.hadoop.metrics2.lib.MutableStat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A convenient mutable metric for throughput measurement]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableRate -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableRates -->
- <class name="MutableRates" extends="org.apache.hadoop.metrics2.lib.MutableMetric"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <doc>
- <![CDATA[Initialize the registry with all the methods in a protocol
- so they all show up in the first snapshot.
- Convenient for JMX implementations.
- @param protocol the protocol class]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="elapsed" type="long"/>
- <doc>
- <![CDATA[Add a rate sample for a rate metric
- @param name of the rate metric
- @param elapsed time]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rb" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <doc>
- <![CDATA[Helper class to manage a group of mutable rate metrics
- This class synchronizes all accesses to the metrics it
- contains, so it should not be used in situations where
- there is high contention on the metrics.
- {@link MutableRatesWithAggregation} is preferable in that
- situation.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableRates -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableRatesWithAggregation -->
- <class name="MutableRatesWithAggregation" extends="org.apache.hadoop.metrics2.lib.MutableMetric"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MutableRatesWithAggregation"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <doc>
- <![CDATA[Initialize the registry with all the methods in a protocol
- so they all show up in the first snapshot.
- Convenient for JMX implementations.
- @param protocol the protocol class]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="elapsed" type="long"/>
- <doc>
- <![CDATA[Add a rate sample for a rate metric.
- @param name of the rate metric
- @param elapsed time]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rb" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <doc>
- <![CDATA[Helper class to manage a group of mutable rate metrics.
- Each thread will maintain a local rate count, and upon snapshot,
- these values will be aggregated into a global rate. This class
- should only be used for long running threads, as any metrics
- produced between the last snapshot and the death of a thread
- will be lost. This allows for significantly higher concurrency
- than {@link MutableRates}. See HADOOP-24420.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableRatesWithAggregation -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableRollingAverages -->
- <class name="MutableRollingAverages" extends="org.apache.hadoop.metrics2.lib.MutableMetric"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="MutableRollingAverages" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor for {@link MutableRollingAverages}.
- @param metricValueName]]>
- </doc>
- </constructor>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <method name="collectThreadLocalStates"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Collects states maintained in {@link ThreadLocal}, if any.]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[@param name
- name of metric
- @param value
- value of metric]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getStats" return="java.util.Map"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="minSamples" type="long"/>
- <doc>
- <![CDATA[Retrieve a map of metric name -> (aggregate).
- Filter out entries that don't have at least minSamples.
- @return a map of peer DataNode Id to the average latency to that
- node seen over the measurement period.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- This class maintains a group of rolling average metrics. It implements the
- algorithm of rolling average, i.e. a number of sliding windows are kept to
- roll over and evict old subsets of samples. Each window has a subset of
- samples in a stream, where sub-sum and sub-total are collected. All sub-sums
- and sub-totals in all windows will be aggregated to final-sum and final-total
- used to compute final average, which is called rolling average.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableRollingAverages -->
- <!-- start class org.apache.hadoop.metrics2.lib.MutableStat -->
- <class name="MutableStat" extends="org.apache.hadoop.metrics2.lib.MutableMetric"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MutableStat" type="java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a sample statistics metric
- @param name of the metric
- @param description of the metric
- @param sampleName of the metric (e.g. "Ops")
- @param valueName of the metric (e.g. "Time", "Latency")
- @param extended create extended stats (stdev, min/max etc.) by default.]]>
- </doc>
- </constructor>
- <constructor name="MutableStat" type="java.lang.String, java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a snapshot stat metric with extended stat off by default
- @param name of the metric
- @param description of the metric
- @param sampleName of the metric (e.g. "Ops")
- @param valueName of the metric (e.g. "Time", "Latency")]]>
- </doc>
- </constructor>
- <method name="setExtended"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="extended" type="boolean"/>
- <doc>
- <![CDATA[Set whether to display the extended stats (stdev, min/max etc.) or not
- @param extended enable/disable displaying extended stats]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numSamples" type="long"/>
- <param name="sum" type="long"/>
- <doc>
- <![CDATA[Add a number of samples and their sum to the running stat
- Note that although use of this method will preserve accurate mean values,
- large values for numSamples may result in inaccurate variance values due
- to the use of a single step of the Welford method for variance calculation.
- @param numSamples number of samples
- @param sum of the samples]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Add a snapshot to the metric
- @param value of the metric]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <method name="lastStat" return="org.apache.hadoop.metrics2.util.SampleStat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a SampleStat object that supports
- calls like StdDev and Mean.
- @return SampleStat]]>
- </doc>
- </method>
- <method name="resetMinMax"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reset the all time min max of the metric]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A mutable metric with stats.
- Useful for keeping throughput/latency stats.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MutableStat -->
- </package>
- <package name="org.apache.hadoop.metrics2.sink">
- <!-- start class org.apache.hadoop.metrics2.sink.FileSink -->
- <class name="FileSink" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSink"/>
- <implements name="java.io.Closeable"/>
- <constructor name="FileSink"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.commons.configuration.SubsetConfiguration"/>
- </method>
- <method name="putMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A metrics sink that writes to a file]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.sink.FileSink -->
- <!-- start class org.apache.hadoop.metrics2.sink.GraphiteSink -->
- <class name="GraphiteSink" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSink"/>
- <implements name="java.io.Closeable"/>
- <constructor name="GraphiteSink"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.commons.configuration.SubsetConfiguration"/>
- </method>
- <method name="putMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A metrics sink that writes to a Graphite server]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.sink.GraphiteSink -->
- <!-- start class org.apache.hadoop.metrics2.sink.RollingFileSystemSink -->
- <class name="RollingFileSystemSink" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSink"/>
- <implements name="java.io.Closeable"/>
- <constructor name="RollingFileSystemSink"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an empty instance. Required for reflection.]]>
- </doc>
- </constructor>
- <constructor name="RollingFileSystemSink" type="long, long"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an instance for testing.
- @param flushIntervalMillis the roll interval in millis
- @param flushOffsetIntervalMillis the roll offset interval in millis]]>
- </doc>
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metrics2Properties" type="org.apache.commons.configuration.SubsetConfiguration"/>
- </method>
- <method name="getRollInterval" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Extract the roll interval from the configuration and return it in
- milliseconds.
- @return the roll interval in millis]]>
- </doc>
- </method>
- <method name="updateFlushTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="now" type="java.util.Date"/>
- <doc>
- <![CDATA[Update the {@link #nextFlush} variable to the next flush time. Add
- an integer number of flush intervals, preserving the initial random offset.
- @param now the current time]]>
- </doc>
- </method>
- <method name="setInitialFlushTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="now" type="java.util.Date"/>
- <doc>
- <![CDATA[Set the {@link #nextFlush} variable to the initial flush time. The initial
- flush will be an integer number of flush intervals past the beginning of
- the current hour and will have a random offset added, up to
- {@link #rollOffsetIntervalMillis}. The initial flush will be a time in
- past that can be used from which to calculate future flush times.
- @param now the current time]]>
- </doc>
- </method>
- <method name="putMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="source" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="ignoreError" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="allowAppend" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="basePath" type="org.apache.hadoop.fs.Path"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="rollIntervalMillis" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="rollOffsetIntervalMillis" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="nextFlush" type="java.util.Calendar"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="forceFlush" type="boolean"
- transient="false" volatile="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="hasFlushed" type="boolean"
- transient="false" volatile="true"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="suppliedConf" type="org.apache.hadoop.conf.Configuration"
- transient="false" volatile="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="suppliedFilesystem" type="org.apache.hadoop.fs.FileSystem"
- transient="false" volatile="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p>This class is a metrics sink that uses
- {@link org.apache.hadoop.fs.FileSystem} to write the metrics logs. Every
- roll interval a new directory will be created under the path specified by the
- <code>basepath</code> property. All metrics will be logged to a file in the
- current interval's directory in a file named <hostname>.log, where
- <hostname> is the name of the host on which the metrics logging
- process is running. The base path is set by the
- <code><prefix>.sink.<instance>.basepath</code> property. The
- time zone used to create the current interval's directory name is GMT. If
- the <code>basepath</code> property isn't specified, it will default to
- "/tmp", which is the temp directory on whatever default file
- system is configured for the cluster.</p>
- <p>The <code><prefix>.sink.<instance>.ignore-error</code>
- property controls whether an exception is thrown when an error is encountered
- writing a log file. The default value is <code>true</code>. When set to
- <code>false</code>, file errors are quietly swallowed.</p>
- <p>The <code>roll-interval</code> property sets the amount of time before
- rolling the directory. The default value is 1 hour. The roll interval may
- not be less than 1 minute. The property's value should be given as
- <i>number unit</i>, where <i>number</i> is an integer value, and
- <i>unit</i> is a valid unit. Valid units are <i>minute</i>, <i>hour</i>,
- and <i>day</i>. The units are case insensitive and may be abbreviated or
- plural. If no units are specified, hours are assumed. For example,
- "2", "2h", "2 hour", and
- "2 hours" are all valid ways to specify two hours.</p>
- <p>The <code>roll-offset-interval-millis</code> property sets the upper
- bound on a random time interval (in milliseconds) that is used to delay
- before the initial roll. All subsequent rolls will happen an integer
- number of roll intervals after the initial roll, hence retaining the original
- offset. The purpose of this property is to insert some variance in the roll
- times so that large clusters using this sink on every node don't cause a
- performance impact on HDFS by rolling simultaneously. The default value is
- 30000 (30s). When writing to HDFS, as a rule of thumb, the roll offset in
- millis should be no less than the number of sink instances times 5.
- <p>The primary use of this class is for logging to HDFS. As it uses
- {@link org.apache.hadoop.fs.FileSystem} to access the target file system,
- however, it can be used to write to the local file system, Amazon S3, or any
- other supported file system. The base path for the sink will determine the
- file system used. An unqualified path will write to the default file system
- set by the configuration.</p>
- <p>Not all file systems support the ability to append to files. In file
- systems without the ability to append to files, only one writer can write to
- a file at a time. To allow for concurrent writes from multiple daemons on a
- single host, the <code>source</code> property is used to set unique headers
- for the log files. The property should be set to the name of
- the source daemon, e.g. <i>namenode</i>. The value of the
- <code>source</code> property should typically be the same as the property's
- prefix. If this property is not set, the source is taken to be
- <i>unknown</i>.</p>
- <p>Instead of appending to an existing file, by default the sink
- will create a new file with a suffix of ".<n>&quet;, where
- <i>n</i> is the next lowest integer that isn't already used in a file name,
- similar to the Hadoop daemon logs. NOTE: the file with the <b>highest</b>
- sequence number is the <b>newest</b> file, unlike the Hadoop daemon logs.</p>
- <p>For file systems that allow append, the sink supports appending to the
- existing file instead. If the <code>allow-append</code> property is set to
- true, the sink will instead append to the existing file on file systems that
- support appends. By default, the <code>allow-append</code> property is
- false.</p>
- <p>Note that when writing to HDFS with <code>allow-append</code> set to true,
- there is a minimum acceptable number of data nodes. If the number of data
- nodes drops below that minimum, the append will succeed, but reading the
- data will fail with an IOException in the DataStreamer class. The minimum
- number of data nodes required for a successful append is generally 2 or
- 3.</p>
- <p>Note also that when writing to HDFS, the file size information is not
- updated until the file is closed (at the end of the interval) even though
- the data is being written successfully. This is a known HDFS limitation that
- exists because of the performance cost of updating the metadata. See
- <a href="https://issues.apache.org/jira/browse/HDFS-5478">HDFS-5478</a>.</p>
- <p>When using this sink in a secure (Kerberos) environment, two additional
- properties must be set: <code>keytab-key</code> and
- <code>principal-key</code>. <code>keytab-key</code> should contain the key by
- which the keytab file can be found in the configuration, for example,
- <code>yarn.nodemanager.keytab</code>. <code>principal-key</code> should
- contain the key by which the principal can be found in the configuration,
- for example, <code>yarn.nodemanager.principal</code>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.sink.RollingFileSystemSink -->
- <!-- start class org.apache.hadoop.metrics2.sink.StatsDSink -->
- <class name="StatsDSink" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSink"/>
- <implements name="java.io.Closeable"/>
- <constructor name="StatsDSink"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.commons.configuration.SubsetConfiguration"/>
- </method>
- <method name="putMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- </method>
- <method name="writeMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="line" type="java.lang.String"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A metrics sink that writes metrics to a StatsD daemon.
- This sink will produce metrics of the form
- '[hostname].servicename.context.name.metricname:value|type'
- where hostname is optional. This is useful when sending to
- a daemon that is running on the localhost and will add the
- hostname to the metric (such as the
- <a href="https://collectd.org/">CollectD</a> StatsD plugin).
- <br/>
- To configure this plugin, you will need to add the following
- entries to your hadoop-metrics2.properties file:
- <br/>
- <pre>
- *.sink.statsd.class=org.apache.hadoop.metrics2.sink.StatsDSink
- [prefix].sink.statsd.server.host=
- [prefix].sink.statsd.server.port=
- [prefix].sink.statsd.skip.hostname=true|false (optional)
- [prefix].sink.statsd.service.name=NameNode (name you want for service)
- </pre>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.sink.StatsDSink -->
- </package>
- <package name="org.apache.hadoop.metrics2.sink.ganglia">
- </package>
- <package name="org.apache.hadoop.metrics2.source">
- </package>
- <package name="org.apache.hadoop.metrics2.util">
- <!-- start class org.apache.hadoop.metrics2.util.MBeans -->
- <class name="MBeans" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MBeans"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="register" return="javax.management.ObjectName"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="serviceName" type="java.lang.String"/>
- <param name="nameName" type="java.lang.String"/>
- <param name="theMbean" type="java.lang.Object"/>
- <doc>
- <![CDATA[Register the MBean using our standard MBeanName format
- "hadoop:service=<serviceName>,name=<nameName>"
- Where the <serviceName> and <nameName> are the supplied parameters
- @param serviceName
- @param nameName
- @param theMbean - the MBean to register
- @return the named used to register the MBean]]>
- </doc>
- </method>
- <method name="getMbeanNameService" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="objectName" type="javax.management.ObjectName"/>
- </method>
- <method name="getMbeanNameName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="objectName" type="javax.management.ObjectName"/>
- </method>
- <method name="unregister"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mbeanName" type="javax.management.ObjectName"/>
- </method>
- <doc>
- <![CDATA[This util class provides a method to register an MBean using
- our standard naming convention as described in the doc
- for {link {@link #register(String, String, Object)}]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.MBeans -->
- <!-- start class org.apache.hadoop.metrics2.util.MetricsCache -->
- <class name="MetricsCache" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsCache"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="MetricsCache" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a metrics cache
- @param maxRecsPerName limit of the number records per record name]]>
- </doc>
- </constructor>
- <method name="update" return="org.apache.hadoop.metrics2.util.MetricsCache.Record"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mr" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- <param name="includingTags" type="boolean"/>
- <doc>
- <![CDATA[Update the cache and return the current cached record
- @param mr the update record
- @param includingTags cache tag values (for later lookup by name) if true
- @return the updated cache record]]>
- </doc>
- </method>
- <method name="update" return="org.apache.hadoop.metrics2.util.MetricsCache.Record"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mr" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- <doc>
- <![CDATA[Update the cache and return the current cache record
- @param mr the update record
- @return the updated cache record]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.metrics2.util.MetricsCache.Record"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="tags" type="java.util.Collection"/>
- <doc>
- <![CDATA[Get the cached record
- @param name of the record
- @param tags of the record
- @return the cached record or null]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A metrics cache for sinks that don't support sparse updates.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.MetricsCache -->
- <!-- start class org.apache.hadoop.metrics2.util.Servers -->
- <class name="Servers" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="parse" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="specs" type="java.lang.String"/>
- <param name="defaultPort" type="int"/>
- <doc>
- <![CDATA[Parses a space and/or comma separated sequence of server specifications
- of the form <i>hostname</i> or <i>hostname:port</i>. If
- the specs string is null, defaults to localhost:defaultPort.
- @param specs server specs (see description)
- @param defaultPort the default port if not specified
- @return a list of InetSocketAddress objects.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Helpers to handle server addresses]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.Servers -->
- </package>
- <package name="org.apache.hadoop.net">
- <!-- start class org.apache.hadoop.net.AbstractDNSToSwitchMapping -->
- <class name="AbstractDNSToSwitchMapping" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.net.DNSToSwitchMapping"/>
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="AbstractDNSToSwitchMapping"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an unconfigured instance]]>
- </doc>
- </constructor>
- <constructor name="AbstractDNSToSwitchMapping" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an instance, caching the configuration file.
- This constructor does not call {@link #setConf(Configuration)}; if
- a subclass extracts information in that method, it must call it explicitly.
- @param conf the configuration]]>
- </doc>
- </constructor>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="isSingleSwitch" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Predicate that indicates that the switch mapping is known to be
- single-switch. The base class returns false: it assumes all mappings are
- multi-rack. Subclasses may override this with methods that are more aware
- of their topologies.
- <p/>
- This method is used when parts of Hadoop need know whether to apply
- single rack vs multi-rack policies, such as during block placement.
- Such algorithms behave differently if they are on multi-switch systems.
- </p>
- @return true if the mapping thinks that it is on a single switch]]>
- </doc>
- </method>
- <method name="getSwitchMap" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a copy of the map (for diagnostics)
- @return a clone of the map or null for none known]]>
- </doc>
- </method>
- <method name="dumpTopology" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Generate a string listing the switch mapping implementation,
- the mapping for every known node and the number of nodes and
- unique switches known about -each entry to a separate line.
- @return a string that can be presented to the ops team or used in
- debug messages.]]>
- </doc>
- </method>
- <method name="isSingleSwitchByScriptPolicy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="isMappingSingleSwitch" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mapping" type="org.apache.hadoop.net.DNSToSwitchMapping"/>
- <doc>
- <![CDATA[Query for a {@link DNSToSwitchMapping} instance being on a single
- switch.
- <p/>
- This predicate simply assumes that all mappings not derived from
- this class are multi-switch.
- @param mapping the mapping to query
- @return true if the base class says it is single switch, or the mapping
- is not derived from this class.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is a base class for DNS to Switch mappings. <p/> It is not mandatory to
- derive {@link DNSToSwitchMapping} implementations from it, but it is strongly
- recommended, as it makes it easy for the Hadoop developers to add new methods
- to this base class that are automatically picked up by all implementations.
- <p/>
- This class does not extend the <code>Configured</code>
- base class, and should not be changed to do so, as it causes problems
- for subclasses. The constructor of the <code>Configured</code> calls
- the {@link #setConf(Configuration)} method, which will call into the
- subclasses before they have been fully constructed.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.AbstractDNSToSwitchMapping -->
- <!-- start class org.apache.hadoop.net.CachedDNSToSwitchMapping -->
- <class name="CachedDNSToSwitchMapping" extends="org.apache.hadoop.net.AbstractDNSToSwitchMapping"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CachedDNSToSwitchMapping" type="org.apache.hadoop.net.DNSToSwitchMapping"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[cache a raw DNS mapping
- @param rawMapping the raw mapping to cache]]>
- </doc>
- </constructor>
- <method name="resolve" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.util.List"/>
- </method>
- <method name="getSwitchMap" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the (host x switch) map.
- @return a copy of the cached map of hosts to rack]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isSingleSwitch" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Delegate the switch topology query to the raw mapping, via
- {@link AbstractDNSToSwitchMapping#isMappingSingleSwitch(DNSToSwitchMapping)}
- @return true iff the raw mapper is considered single-switch.]]>
- </doc>
- </method>
- <method name="reloadCachedMappings"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="reloadCachedMappings"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.util.List"/>
- </method>
- <field name="rawMapping" type="org.apache.hadoop.net.DNSToSwitchMapping"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The uncached mapping]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A cached implementation of DNSToSwitchMapping that takes an
- raw DNSToSwitchMapping and stores the resolved network location in
- a cache. The following calls to a resolved network location
- will get its location from the cache.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.CachedDNSToSwitchMapping -->
- <!-- start class org.apache.hadoop.net.ConnectTimeoutException -->
- <class name="ConnectTimeoutException" extends="java.net.SocketTimeoutException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ConnectTimeoutException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Thrown by {@link NetUtils#connect(java.net.Socket, java.net.SocketAddress, int)}
- if it times out while connecting to the remote host.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.ConnectTimeoutException -->
- <!-- start interface org.apache.hadoop.net.DNSToSwitchMapping -->
- <interface name="DNSToSwitchMapping" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="resolve" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.util.List"/>
- <doc>
- <![CDATA[Resolves a list of DNS-names/IP-addresses and returns back a list of
- switch information (network paths). One-to-one correspondence must be
- maintained between the elements in the lists.
- Consider an element in the argument list - x.y.com. The switch information
- that is returned must be a network path of the form /foo/rack,
- where / is the root, and 'foo' is the switch where 'rack' is connected.
- Note the hostname/ip-address is not part of the returned path.
- The network topology of the cluster would determine the number of
- components in the network path.
- <p/>
- If a name cannot be resolved to a rack, the implementation
- should return {@link NetworkTopology#DEFAULT_RACK}. This
- is what the bundled implementations do, though it is not a formal requirement
- @param names the list of hosts to resolve (can be empty)
- @return list of resolved network paths.
- If <i>names</i> is empty, the returned list is also empty]]>
- </doc>
- </method>
- <method name="reloadCachedMappings"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reload all of the cached mappings.
- If there is a cache, this method will clear it, so that future accesses
- will get a chance to see the new data.]]>
- </doc>
- </method>
- <method name="reloadCachedMappings"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.util.List"/>
- <doc>
- <![CDATA[Reload cached mappings on specific nodes.
- If there is a cache on these nodes, this method will clear it, so that
- future accesses will see updated data.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An interface that must be implemented to allow pluggable
- DNS-name/IP-address to RackID resolvers.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.net.DNSToSwitchMapping -->
- <!-- start class org.apache.hadoop.net.ScriptBasedMapping -->
- <class name="ScriptBasedMapping" extends="org.apache.hadoop.net.CachedDNSToSwitchMapping"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ScriptBasedMapping"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an instance with the default configuration.
- </p>
- Calling {@link #setConf(Configuration)} will trigger a
- re-evaluation of the configuration settings and so be used to
- set up the mapping script.]]>
- </doc>
- </constructor>
- <constructor name="ScriptBasedMapping" type="org.apache.hadoop.net.DNSToSwitchMapping"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an instance from the given raw mapping
- @param rawMap raw DNSTOSwithMapping]]>
- </doc>
- </constructor>
- <constructor name="ScriptBasedMapping" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an instance from the given configuration
- @param conf configuration]]>
- </doc>
- </constructor>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[{@inheritDoc}
- <p/>
- This will get called in the superclass constructor, so a check is needed
- to ensure that the raw mapping is defined before trying to relaying a null
- configuration.
- @param conf]]>
- </doc>
- </method>
- <field name="NO_SCRIPT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Text used in the {@link #toString()} method if there is no string
- {@value}]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This class implements the {@link DNSToSwitchMapping} interface using a
- script configured via the
- {@link CommonConfigurationKeys#NET_TOPOLOGY_SCRIPT_FILE_NAME_KEY} option.
- <p/>
- It contains a static class <code>RawScriptBasedMapping</code> that performs
- the work: reading the configuration parameters, executing any defined
- script, handling errors and such like. The outer
- class extends {@link CachedDNSToSwitchMapping} to cache the delegated
- queries.
- <p/>
- This DNS mapper's {@link #isSingleSwitch()} predicate returns
- true if and only if a script is defined.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.ScriptBasedMapping -->
- <!-- start class org.apache.hadoop.net.SocksSocketFactory -->
- <class name="SocksSocketFactory" extends="javax.net.SocketFactory"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="SocksSocketFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default empty constructor (for use with the reflection API).]]>
- </doc>
- </constructor>
- <constructor name="SocksSocketFactory" type="java.net.Proxy"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor with a supplied Proxy
-
- @param proxy the proxy to use to create sockets]]>
- </doc>
- </constructor>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetAddress"/>
- <param name="port" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetAddress"/>
- <param name="port" type="int"/>
- <param name="localHostAddr" type="java.net.InetAddress"/>
- <param name="localPort" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="localHostAddr" type="java.net.InetAddress"/>
- <param name="localPort" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <doc>
- <![CDATA[Specialized SocketFactory to create sockets with a SOCKS proxy]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.SocksSocketFactory -->
- <!-- start class org.apache.hadoop.net.StandardSocketFactory -->
- <class name="StandardSocketFactory" extends="javax.net.SocketFactory"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StandardSocketFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default empty constructor (for use with the reflection API).]]>
- </doc>
- </constructor>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetAddress"/>
- <param name="port" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetAddress"/>
- <param name="port" type="int"/>
- <param name="localHostAddr" type="java.net.InetAddress"/>
- <param name="localPort" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="localHostAddr" type="java.net.InetAddress"/>
- <param name="localPort" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Specialized SocketFactory to create sockets with a SOCKS proxy]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.StandardSocketFactory -->
- <!-- start class org.apache.hadoop.net.TableMapping -->
- <class name="TableMapping" extends="org.apache.hadoop.net.CachedDNSToSwitchMapping"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TableMapping"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="reloadCachedMappings"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p>
- Simple {@link DNSToSwitchMapping} implementation that reads a 2 column text
- file. The columns are separated by whitespace. The first column is a DNS or
- IP address and the second column specifies the rack where the address maps.
- </p>
- <p>
- This class uses the configuration parameter {@code
- net.topology.table.file.name} to locate the mapping file.
- </p>
- <p>
- Calls to {@link #resolve(List)} will look up the address as defined in the
- mapping file. If no entry corresponding to the address is found, the value
- {@code /default-rack} is returned.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.TableMapping -->
- <doc>
- <![CDATA[Network-related classes.]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.net.unix">
- </package>
- <package name="org.apache.hadoop.record">
- <!-- start class org.apache.hadoop.record.BinaryRecordInput -->
- <class name="BinaryRecordInput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <implements name="org.apache.hadoop.record.RecordInput"/>
- <constructor name="BinaryRecordInput" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of BinaryRecordInput]]>
- </doc>
- </constructor>
- <constructor name="BinaryRecordInput" type="java.io.DataInput"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of BinaryRecordInput]]>
- </doc>
- </constructor>
- <method name="get" return="org.apache.hadoop.record.BinaryRecordInput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inp" type="java.io.DataInput"/>
- <doc>
- <![CDATA[Get a thread-local record input for the supplied DataInput.
- @param inp data input stream
- @return binary record input corresponding to the supplied DataInput.]]>
- </doc>
- </method>
- <method name="readByte" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBool" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBuffer" return="org.apache.hadoop.record.Buffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.BinaryRecordInput -->
- <!-- start class org.apache.hadoop.record.BinaryRecordOutput -->
- <class name="BinaryRecordOutput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <implements name="org.apache.hadoop.record.RecordOutput"/>
- <constructor name="BinaryRecordOutput" type="java.io.OutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of BinaryRecordOutput]]>
- </doc>
- </constructor>
- <constructor name="BinaryRecordOutput" type="java.io.DataOutput"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of BinaryRecordOutput]]>
- </doc>
- </constructor>
- <method name="get" return="org.apache.hadoop.record.BinaryRecordOutput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <doc>
- <![CDATA[Get a thread-local record output for the supplied DataOutput.
- @param out data output stream
- @return binary record output corresponding to the supplied DataOutput.]]>
- </doc>
- </method>
- <method name="writeByte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="boolean"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="long"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="float"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeDouble"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="d" type="double"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="org.apache.hadoop.record.Buffer"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.BinaryRecordOutput -->
- <!-- start class org.apache.hadoop.record.Buffer -->
- <class name="Buffer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://avro.apache.org/quote_cHaR>AvrolEsS_tHaN/a>.">
- <implements name="java.lang.Comparable"/>
- <implements name="java.lang.Cloneable"/>
- <constructor name="Buffer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a zero-count sequence.]]>
- </doc>
- </constructor>
- <constructor name="Buffer" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a Buffer using the byte array as the initial value.
- @param bytes This array becomes the backing storage for the object.]]>
- </doc>
- </constructor>
- <constructor name="Buffer" type="byte[], int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a Buffer using the byte range as the initial value.
- @param bytes Copy of this array becomes the backing storage for the object.
- @param offset offset into byte array
- @param length length of data]]>
- </doc>
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <doc>
- <![CDATA[Use the specified bytes array as underlying sequence.
- @param bytes byte sequence]]>
- </doc>
- </method>
- <method name="copy"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Copy the specified byte array to the Buffer. Replaces the current buffer.
- @param bytes byte array to be assigned
- @param offset offset into byte array
- @param length length of data]]>
- </doc>
- </method>
- <method name="get" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the data from the Buffer.
-
- @return The data is only valid between 0 and getCount() - 1.]]>
- </doc>
- </method>
- <method name="getCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current count of the buffer.]]>
- </doc>
- </method>
- <method name="getCapacity" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the capacity, which is the maximum count that could handled without
- resizing the backing storage.
-
- @return The number of bytes]]>
- </doc>
- </method>
- <method name="setCapacity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newCapacity" type="int"/>
- <doc>
- <![CDATA[Change the capacity of the backing storage.
- The data is preserved if newCapacity {@literal >=} getCount().
- @param newCapacity The new capacity in bytes.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reset the buffer to 0 size]]>
- </doc>
- </method>
- <method name="truncate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Change the capacity of the backing store to be the same as the current
- count of buffer.]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Append specified bytes to the buffer.
- @param bytes byte array to be appended
- @param offset offset into byte array
- @param length length of data]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <doc>
- <![CDATA[Append specified bytes to the buffer
- @param bytes byte array to be appended]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- <doc>
- <![CDATA[Define the sort order of the Buffer.
-
- @param other The other buffer
- @return Positive if this is bigger than other, 0 if they are equal, and
- negative if this is smaller than other.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="charsetName" type="java.lang.String"/>
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- <doc>
- <![CDATA[Convert the byte buffer to a string an specific character encoding
- @param charsetName Valid Java Character Set Name]]>
- </doc>
- </method>
- <method name="clone" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="CloneNotSupportedException" type="java.lang.CloneNotSupportedException"/>
- </method>
- <doc>
- <![CDATA[A byte sequence that is used as a Java native type for buffer.
- It is resizable and distinguishes between the count of the sequence and
- the current capacity.
-
- @deprecated Replaced by <a href="http://avro.apache.org/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.Buffer -->
- <!-- start class org.apache.hadoop.record.CsvRecordInput -->
- <class name="CsvRecordInput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <implements name="org.apache.hadoop.record.RecordInput"/>
- <constructor name="CsvRecordInput" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of CsvRecordInput]]>
- </doc>
- </constructor>
- <method name="readByte" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBool" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBuffer" return="org.apache.hadoop.record.Buffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.CsvRecordInput -->
- <!-- start class org.apache.hadoop.record.CsvRecordOutput -->
- <class name="CsvRecordOutput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <implements name="org.apache.hadoop.record.RecordOutput"/>
- <constructor name="CsvRecordOutput" type="java.io.OutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of CsvRecordOutput]]>
- </doc>
- </constructor>
- <method name="writeByte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="boolean"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="long"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="float"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeDouble"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="d" type="double"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="org.apache.hadoop.record.Buffer"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.CsvRecordOutput -->
- <!-- start interface org.apache.hadoop.record.Index -->
- <interface name="Index" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <method name="done" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Interface that acts as an iterator for deserializing maps.
- The deserializer returns an instance that the record uses to
- read vectors and maps. An example of usage is as follows:
- <code>
- Index idx = startVector(...);
- while (!idx.done()) {
- .... // read element of a vector
- idx.incr();
- }
- </code>
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.record.Index -->
- <!-- start class org.apache.hadoop.record.Record -->
- <class name="Record" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <implements name="java.lang.Cloneable"/>
- <constructor name="Record"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="serialize"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rout" type="org.apache.hadoop.record.RecordOutput"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize a record with tag (ususally field name)
- @param rout Record output destination
- @param tag record tag (Used only in tagged serialization e.g. XML)]]>
- </doc>
- </method>
- <method name="deserialize"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rin" type="org.apache.hadoop.record.RecordInput"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deserialize a record with a tag (usually field name)
- @param rin Record input source
- @param tag Record tag (Used only in tagged serialization e.g. XML)]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="peer" type="java.lang.Object"/>
- <exception name="ClassCastException" type="java.lang.ClassCastException"/>
- </method>
- <method name="serialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rout" type="org.apache.hadoop.record.RecordOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize a record without a tag
- @param rout Record output destination]]>
- </doc>
- </method>
- <method name="deserialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rin" type="org.apache.hadoop.record.RecordInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deserialize a record without a tag
- @param rin Record input source]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="din" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Abstract class that is extended by generated classes.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.Record -->
- <!-- start class org.apache.hadoop.record.RecordComparator -->
- <class name="RecordComparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="RecordComparator" type="java.lang.Class"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a raw {@link Record} comparison implementation.]]>
- </doc>
- </constructor>
- <method name="compare" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <method name="define"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <param name="comparator" type="org.apache.hadoop.record.RecordComparator"/>
- <doc>
- <![CDATA[Register an optimized comparator for a {@link Record} implementation.
- @param c record classs for which a raw comparator is provided
- @param comparator Raw comparator instance for class c]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A raw record comparator base class
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.RecordComparator -->
- <!-- start interface org.apache.hadoop.record.RecordInput -->
- <interface name="RecordInput" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <method name="readByte" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a byte from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readBool" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a boolean from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read an integer from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a long integer from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a single-precision float from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a double-precision number from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a UTF-8 encoded string from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readBuffer" return="org.apache.hadoop.record.Buffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read byte array from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for start of the serialized record.
- @param tag Used by tagged serialization formats (such as XML)]]>
- </doc>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for end of the serialized record.
- @param tag Used by tagged serialization formats (such as XML)]]>
- </doc>
- </method>
- <method name="startVector" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for start of the serialized vector.
- @param tag Used by tagged serialization formats (such as XML)
- @return Index that is used to count the number of elements.]]>
- </doc>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for end of the serialized vector.
- @param tag Used by tagged serialization formats (such as XML)]]>
- </doc>
- </method>
- <method name="startMap" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for start of the serialized map.
- @param tag Used by tagged serialization formats (such as XML)
- @return Index that is used to count the number of map entries.]]>
- </doc>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for end of the serialized map.
- @param tag Used by tagged serialization formats (such as XML)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface that all the Deserializers have to implement.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.record.RecordInput -->
- <!-- start interface org.apache.hadoop.record.RecordOutput -->
- <interface name="RecordOutput" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <method name="writeByte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a byte to serialized record.
- @param b Byte to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeBool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="boolean"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a boolean to serialized record.
- @param b Boolean to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write an integer to serialized record.
- @param i Integer to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="long"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a long integer to serialized record.
- @param l Long to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="float"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a single-precision float to serialized record.
- @param f Float to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeDouble"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="d" type="double"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a double precision floating point number to serialized record.
- @param d Double to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a unicode string to serialized record.
- @param s String to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="org.apache.hadoop.record.Buffer"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a buffer to serialized record.
- @param buf Buffer to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the start of a record to be serialized.
- @param r Record to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the end of a serialized record.
- @param r Record to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="startVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the start of a vector to be serialized.
- @param v Vector to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the end of a serialized vector.
- @param v Vector to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="startMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="m" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the start of a map to be serialized.
- @param m Map to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="m" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the end of a serialized map.
- @param m Map to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface that all the serializers have to implement.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.record.RecordOutput -->
- <!-- start class org.apache.hadoop.record.Utils -->
- <class name="Utils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://avro.apache.org/quote_cHaR>AvrolEsS_tHaN/a>.">
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse a float from a byte array.]]>
- </doc>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse a double from a byte array.]]>
- </doc>
- </method>
- <method name="readVLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded long from a byte array and returns it.
- @param bytes byte array with decode long
- @param start starting index
- @throws java.io.IOException
- @return deserialized long]]>
- </doc>
- </method>
- <method name="readVInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded integer from a byte array and returns it.
- @param bytes byte array with the encoded integer
- @param start start index
- @throws java.io.IOException
- @return deserialized integer]]>
- </doc>
- </method>
- <method name="readVLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded long from a stream and return it.
- @param in input stream
- @throws java.io.IOException
- @return deserialized long]]>
- </doc>
- </method>
- <method name="readVInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded integer from a stream and returns it.
- @param in input stream
- @throws java.io.IOException
- @return deserialized integer]]>
- </doc>
- </method>
- <method name="getVIntSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="long"/>
- <doc>
- <![CDATA[Get the encoded length if an integer is stored in a variable-length format
- @return the encoded length]]>
- </doc>
- </method>
- <method name="writeVLong"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataOutput"/>
- <param name="i" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serializes a long to a binary stream with zero-compressed encoding.
- For {@literal -112 <= i <= 127}, only one byte is used with the actual
- value. For other values of i, the first byte value indicates whether the
- long is positive or negative, and the number of bytes that follow.
- If the first byte value v is between -113 and -120, the following long
- is positive, with number of bytes that follow are -(v+112).
- If the first byte value v is between -121 and -128, the following long
- is negative, with number of bytes that follow are -(v+120). Bytes are
- stored in the high-non-zero-byte-first order.
- @param stream Binary output stream
- @param i Long to be serialized
- @throws java.io.IOException]]>
- </doc>
- </method>
- <method name="writeVInt"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataOutput"/>
- <param name="i" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serializes an int to a binary stream with zero-compressed encoding.
- @param stream Binary output stream
- @param i int to be serialized
- @throws java.io.IOException]]>
- </doc>
- </method>
- <method name="compareBytes" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- <doc>
- <![CDATA[Lexicographic order of binary data.]]>
- </doc>
- </method>
- <field name="hexchars" type="char[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Various utility functions for Hadoop record I/O runtime.
-
- @deprecated Replaced by <a href="http://avro.apache.org/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.Utils -->
- <!-- start class org.apache.hadoop.record.XmlRecordInput -->
- <class name="XmlRecordInput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <implements name="org.apache.hadoop.record.RecordInput"/>
- <constructor name="XmlRecordInput" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of XmlRecordInput]]>
- </doc>
- </constructor>
- <method name="readByte" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBool" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBuffer" return="org.apache.hadoop.record.Buffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[XML Deserializer.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.XmlRecordInput -->
- <!-- start class org.apache.hadoop.record.XmlRecordOutput -->
- <class name="XmlRecordOutput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <implements name="org.apache.hadoop.record.RecordOutput"/>
- <constructor name="XmlRecordOutput" type="java.io.OutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of XmlRecordOutput]]>
- </doc>
- </constructor>
- <method name="writeByte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="boolean"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="long"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="float"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeDouble"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="d" type="double"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="org.apache.hadoop.record.Buffer"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[XML Serializer.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.XmlRecordOutput -->
- <doc>
- <![CDATA[<p>
- (DEPRECATED) Hadoop record I/O contains classes and a record description language
- translator for simplifying serialization and deserialization of records in a
- language-neutral manner.
- </p>
-
- <p>
- DEPRECATED: Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
- </p>
-
- <h2>Introduction</h2>
-
- Software systems of any significant complexity require mechanisms for data
- interchange with the outside world. These interchanges typically involve the
- marshaling and unmarshaling of logical units of data to and from data streams
- (files, network connections, memory buffers etc.). Applications usually have
- some code for serializing and deserializing the data types that they manipulate
- embedded in them. The work of serialization has several features that make
- automatic code generation for it worthwhile. Given a particular output encoding
- (binary, XML, etc.), serialization of primitive types and simple compositions
- of primitives (structs, vectors etc.) is a very mechanical task. Manually
- written serialization code can be susceptible to bugs especially when records
- have a large number of fields or a record definition changes between software
- versions. Lastly, it can be very useful for applications written in different
- programming languages to be able to share and interchange data. This can be
- made a lot easier by describing the data records manipulated by these
- applications in a language agnostic manner and using the descriptions to derive
- implementations of serialization in multiple target languages.
- This document describes Hadoop Record I/O, a mechanism that is aimed
- at
- <ul>
- <li> enabling the specification of simple serializable data types (records)
- <li> enabling the generation of code in multiple target languages for
- marshaling and unmarshaling such types
- <li> providing target language specific support that will enable application
- programmers to incorporate generated code into their applications
- </ul>
- The goals of Hadoop Record I/O are similar to those of mechanisms such as XDR,
- ASN.1, PADS and ICE. While these systems all include a DDL that enables
- the specification of most record types, they differ widely in what else they
- focus on. The focus in Hadoop Record I/O is on data marshaling and
- multi-lingual support. We take a translator-based approach to serialization.
- Hadoop users have to describe their data in a simple data description
- language. The Hadoop DDL translator rcc generates code that users
- can invoke in order to read/write their data from/to simple stream
- abstractions. Next we list explicitly some of the goals and non-goals of
- Hadoop Record I/O.
- <h3>Goals</h3>
- <ul>
- <li> Support for commonly used primitive types. Hadoop should include as
- primitives commonly used builtin types from programming languages we intend to
- support.
- <li> Support for common data compositions (including recursive compositions).
- Hadoop should support widely used composite types such as structs and
- vectors.
- <li> Code generation in multiple target languages. Hadoop should be capable of
- generating serialization code in multiple target languages and should be
- easily extensible to new target languages. The initial target languages are
- C++ and Java.
- <li> Support for generated target languages. Hadooop should include support
- in the form of headers, libraries, packages for supported target languages
- that enable easy inclusion and use of generated code in applications.
- <li> Support for multiple output encodings. Candidates include
- packed binary, comma-separated text, XML etc.
- <li> Support for specifying record types in a backwards/forwards compatible
- manner. This will probably be in the form of support for optional fields in
- records. This version of the document does not include a description of the
- planned mechanism, we intend to include it in the next iteration.
- </ul>
- <h3>Non-Goals</h3>
- <ul>
- <li> Serializing existing arbitrary C++ classes.
- <li> Serializing complex data structures such as trees, linked lists etc.
- <li> Built-in indexing schemes, compression, or check-sums.
- <li> Dynamic construction of objects from an XML schema.
- </ul>
- The remainder of this document describes the features of Hadoop record I/O
- in more detail. Section 2 describes the data types supported by the system.
- Section 3 lays out the DDL syntax with some examples of simple records.
- Section 4 describes the process of code generation with rcc. Section 5
- describes target language mappings and support for Hadoop types. We include a
- fairly complete description of C++ mappings with intent to include Java and
- others in upcoming iterations of this document. The last section talks about
- supported output encodings.
- <h2>Data Types and Streams</h2>
- This section describes the primitive and composite types supported by Hadoop.
- We aim to support a set of types that can be used to simply and efficiently
- express a wide range of record types in different programming languages.
- <h3>Primitive Types</h3>
- For the most part, the primitive types of Hadoop map directly to primitive
- types in high level programming languages. Special cases are the
- ustring (a Unicode string) and buffer types, which we believe
- find wide use and which are usually implemented in library code and not
- available as language built-ins. Hadoop also supplies these via library code
- when a target language built-in is not present and there is no widely
- adopted "standard" implementation. The complete list of primitive types is:
- <ul>
- <li> byte: An 8-bit unsigned integer.
- <li> boolean: A boolean value.
- <li> int: A 32-bit signed integer.
- <li> long: A 64-bit signed integer.
- <li> float: A single precision floating point number as described by
- IEEE-754.
- <li> double: A double precision floating point number as described by
- IEEE-754.
- <li> ustring: A string consisting of Unicode characters.
- <li> buffer: An arbitrary sequence of bytes.
- </ul>
- <h3>Composite Types</h3>
- Hadoop supports a small set of composite types that enable the description
- of simple aggregate types and containers. A composite type is serialized
- by sequentially serializing it constituent elements. The supported
- composite types are:
- <ul>
- <li> record: An aggregate type like a C-struct. This is a list of
- typed fields that are together considered a single unit of data. A record
- is serialized by sequentially serializing its constituent fields. In addition
- to serialization a record has comparison operations (equality and less-than)
- implemented for it, these are defined as memberwise comparisons.
- <li>vector: A sequence of entries of the same data type, primitive
- or composite.
- <li> map: An associative container mapping instances of a key type to
- instances of a value type. The key and value types may themselves be primitive
- or composite types.
- </ul>
- <h3>Streams</h3>
- Hadoop generates code for serializing and deserializing record types to
- abstract streams. For each target language Hadoop defines very simple input
- and output stream interfaces. Application writers can usually develop
- concrete implementations of these by putting a one method wrapper around
- an existing stream implementation.
- <h2>DDL Syntax and Examples</h2>
- We now describe the syntax of the Hadoop data description language. This is
- followed by a few examples of DDL usage.
-
- <h3>Hadoop DDL Syntax</h3>
- <pre><code>
- recfile = *include module *record
- include = "include" path
- path = (relative-path / absolute-path)
- module = "module" module-name
- module-name = name *("." name)
- record := "class" name "{" 1*(field) "}"
- field := type name ";"
- name := ALPHA (ALPHA / DIGIT / "_" )*
- type := (ptype / ctype)
- ptype := ("byte" / "boolean" / "int" |
- "long" / "float" / "double"
- "ustring" / "buffer")
- ctype := (("vector" "<" type ">") /
- ("map" "<" type "," type ">" ) ) / name)
- </code></pre>
- A DDL file describes one or more record types. It begins with zero or
- more include declarations, a single mandatory module declaration
- followed by zero or more class declarations. The semantics of each of
- these declarations are described below:
- <ul>
- <li>include: An include declaration specifies a DDL file to be
- referenced when generating code for types in the current DDL file. Record types
- in the current compilation unit may refer to types in all included files.
- File inclusion is recursive. An include does not trigger code
- generation for the referenced file.
- <li> module: Every Hadoop DDL file must have a single module
- declaration that follows the list of includes and precedes all record
- declarations. A module declaration identifies a scope within which
- the names of all types in the current file are visible. Module names are
- mapped to C++ namespaces, Java packages etc. in generated code.
- <li> class: Records types are specified through class
- declarations. A class declaration is like a Java class declaration.
- It specifies a named record type and a list of fields that constitute records
- of the type. Usage is illustrated in the following examples.
- </ul>
- <h3>Examples</h3>
- <ul>
- <li>A simple DDL file links.jr with just one record declaration.
- <pre><code>
- module links {
- class Link {
- ustring URL;
- boolean isRelative;
- ustring anchorText;
- };
- }
- </code></pre>
- <li> A DDL file outlinks.jr which includes another
- <pre><code>
- include "links.jr"
- module outlinks {
- class OutLinks {
- ustring baseURL;
- vector<links.Link> outLinks;
- };
- }
- </code></pre>
- </ul>
- <h2>Code Generation</h2>
- The Hadoop translator is written in Java. Invocation is done by executing a
- wrapper shell script named named rcc. It takes a list of
- record description files as a mandatory argument and an
- optional language argument (the default is Java) --language or
- -l. Thus a typical invocation would look like:
- <pre><code>
- $ rcc -l C++ <filename> ...
- </code></pre>
- <h2>Target Language Mappings and Support</h2>
- For all target languages, the unit of code generation is a record type.
- For each record type, Hadoop generates code for serialization and
- deserialization, record comparison and access to record members.
- <h3>C++</h3>
- Support for including Hadoop generated C++ code in applications comes in the
- form of a header file recordio.hh which needs to be included in source
- that uses Hadoop types and a library librecordio.a which applications need
- to be linked with. The header declares the Hadoop C++ namespace which defines
- appropriate types for the various primitives, the basic interfaces for
- records and streams and enumerates the supported serialization encodings.
- Declarations of these interfaces and a description of their semantics follow:
- <pre><code>
- namespace hadoop {
- enum RecFormat { kBinary, kXML, kCSV };
- class InStream {
- public:
- virtual ssize_t read(void *buf, size_t n) = 0;
- };
- class OutStream {
- public:
- virtual ssize_t write(const void *buf, size_t n) = 0;
- };
- class IOError : public runtime_error {
- public:
- explicit IOError(const std::string& msg);
- };
- class IArchive;
- class OArchive;
- class RecordReader {
- public:
- RecordReader(InStream& in, RecFormat fmt);
- virtual ~RecordReader(void);
- virtual void read(Record& rec);
- };
- class RecordWriter {
- public:
- RecordWriter(OutStream& out, RecFormat fmt);
- virtual ~RecordWriter(void);
- virtual void write(Record& rec);
- };
- class Record {
- public:
- virtual std::string type(void) const = 0;
- virtual std::string signature(void) const = 0;
- protected:
- virtual bool validate(void) const = 0;
- virtual void
- serialize(OArchive& oa, const std::string& tag) const = 0;
- virtual void
- deserialize(IArchive& ia, const std::string& tag) = 0;
- };
- }
- </code></pre>
- <ul>
- <li> RecFormat: An enumeration of the serialization encodings supported
- by this implementation of Hadoop.
- <li> InStream: A simple abstraction for an input stream. This has a
- single public read method that reads n bytes from the stream into
- the buffer buf. Has the same semantics as a blocking read system
- call. Returns the number of bytes read or -1 if an error occurs.
- <li> OutStream: A simple abstraction for an output stream. This has a
- single write method that writes n bytes to the stream from the
- buffer buf. Has the same semantics as a blocking write system
- call. Returns the number of bytes written or -1 if an error occurs.
- <li> RecordReader: A RecordReader reads records one at a time from
- an underlying stream in a specified record format. The reader is instantiated
- with a stream and a serialization format. It has a read method that
- takes an instance of a record and deserializes the record from the stream.
- <li> RecordWriter: A RecordWriter writes records one at a
- time to an underlying stream in a specified record format. The writer is
- instantiated with a stream and a serialization format. It has a
- write method that takes an instance of a record and serializes the
- record to the stream.
- <li> Record: The base class for all generated record types. This has two
- public methods type and signature that return the typename and the
- type signature of the record.
- </ul>
- Two files are generated for each record file (note: not for each record). If a
- record file is named "name.jr", the generated files are
- "name.jr.cc" and "name.jr.hh" containing serialization
- implementations and record type declarations respectively.
- For each record in the DDL file, the generated header file will contain a
- class definition corresponding to the record type, method definitions for the
- generated type will be present in the '.cc' file. The generated class will
- inherit from the abstract class hadoop::Record. The DDL files
- module declaration determines the namespace the record belongs to.
- Each '.' delimited token in the module declaration results in the
- creation of a namespace. For instance, the declaration module docs.links
- results in the creation of a docs namespace and a nested
- docs::links namespace. In the preceding examples, the Link class
- is placed in the links namespace. The header file corresponding to
- the links.jr file will contain:
- <pre><code>
- namespace links {
- class Link : public hadoop::Record {
- // ....
- };
- };
- </code></pre>
- Each field within the record will cause the generation of a private member
- declaration of the appropriate type in the class declaration, and one or more
- acccessor methods. The generated class will implement the serialize and
- deserialize methods defined in hadoop::Record+. It will also
- implement the inspection methods type and signature from
- hadoop::Record. A default constructor and virtual destructor will also
- be generated. Serialization code will read/write records into streams that
- implement the hadoop::InStream and the hadoop::OutStream interfaces.
- For each member of a record an accessor method is generated that returns
- either the member or a reference to the member. For members that are returned
- by value, a setter method is also generated. This is true for primitive
- data members of the types byte, int, long, boolean, float and
- double. For example, for a int field called MyField the folowing
- code is generated.
- <pre><code>
- ...
- private:
- int32_t mMyField;
- ...
- public:
- int32_t getMyField(void) const {
- return mMyField;
- };
- void setMyField(int32_t m) {
- mMyField = m;
- };
- ...
- </code></pre>
- For a ustring or buffer or composite field. The generated code
- only contains accessors that return a reference to the field. A const
- and a non-const accessor are generated. For example:
- <pre><code>
- ...
- private:
- std::string mMyBuf;
- ...
- public:
- std::string& getMyBuf() {
- return mMyBuf;
- };
- const std::string& getMyBuf() const {
- return mMyBuf;
- };
- ...
- </code></pre>
- <h4>Examples</h4>
- Suppose the inclrec.jr file contains:
- <pre><code>
- module inclrec {
- class RI {
- int I32;
- double D;
- ustring S;
- };
- }
- </code></pre>
- and the testrec.jr file contains:
- <pre><code>
- include "inclrec.jr"
- module testrec {
- class R {
- vector<float> VF;
- RI Rec;
- buffer Buf;
- };
- }
- </code></pre>
- Then the invocation of rcc such as:
- <pre><code>
- $ rcc -l c++ inclrec.jr testrec.jr
- </code></pre>
- will result in generation of four files:
- inclrec.jr.{cc,hh} and testrec.jr.{cc,hh}.
- The inclrec.jr.hh will contain:
- <pre><code>
- #ifndef _INCLREC_JR_HH_
- #define _INCLREC_JR_HH_
- #include "recordio.hh"
- namespace inclrec {
-
- class RI : public hadoop::Record {
- private:
- int32_t I32;
- double D;
- std::string S;
- public:
- RI(void);
- virtual ~RI(void);
- virtual bool operator==(const RI& peer) const;
- virtual bool operator<(const RI& peer) const;
- virtual int32_t getI32(void) const { return I32; }
- virtual void setI32(int32_t v) { I32 = v; }
- virtual double getD(void) const { return D; }
- virtual void setD(double v) { D = v; }
- virtual std::string& getS(void) const { return S; }
- virtual const std::string& getS(void) const { return S; }
- virtual std::string type(void) const;
- virtual std::string signature(void) const;
- protected:
- virtual void serialize(hadoop::OArchive& a) const;
- virtual void deserialize(hadoop::IArchive& a);
- };
- } // end namespace inclrec
- #endif /* _INCLREC_JR_HH_ */
- </code></pre>
- The testrec.jr.hh file will contain:
- <pre><code>
- #ifndef _TESTREC_JR_HH_
- #define _TESTREC_JR_HH_
- #include "inclrec.jr.hh"
- namespace testrec {
- class R : public hadoop::Record {
- private:
- std::vector<float> VF;
- inclrec::RI Rec;
- std::string Buf;
- public:
- R(void);
- virtual ~R(void);
- virtual bool operator==(const R& peer) const;
- virtual bool operator<(const R& peer) const;
- virtual std::vector<float>& getVF(void) const;
- virtual const std::vector<float>& getVF(void) const;
- virtual std::string& getBuf(void) const ;
- virtual const std::string& getBuf(void) const;
- virtual inclrec::RI& getRec(void) const;
- virtual const inclrec::RI& getRec(void) const;
-
- virtual bool serialize(hadoop::OutArchive& a) const;
- virtual bool deserialize(hadoop::InArchive& a);
-
- virtual std::string type(void) const;
- virtual std::string signature(void) const;
- };
- }; // end namespace testrec
- #endif /* _TESTREC_JR_HH_ */
- </code></pre>
- <h3>Java</h3>
- Code generation for Java is similar to that for C++. A Java class is generated
- for each record type with private members corresponding to the fields. Getters
- and setters for fields are also generated. Some differences arise in the
- way comparison is expressed and in the mapping of modules to packages and
- classes to files. For equality testing, an equals method is generated
- for each record type. As per Java requirements a hashCode method is also
- generated. For comparison a compareTo method is generated for each
- record type. This has the semantics as defined by the Java Comparable
- interface, that is, the method returns a negative integer, zero, or a positive
- integer as the invoked object is less than, equal to, or greater than the
- comparison parameter.
- A .java file is generated per record type as opposed to per DDL
- file as in C++. The module declaration translates to a Java
- package declaration. The module name maps to an identical Java package
- name. In addition to this mapping, the DDL compiler creates the appropriate
- directory hierarchy for the package and places the generated .java
- files in the correct directories.
- <h2>Mapping Summary</h2>
- <pre><code>
- DDL Type C++ Type Java Type
- boolean bool boolean
- byte int8_t byte
- int int32_t int
- long int64_t long
- float float float
- double double double
- ustring std::string java.lang.String
- buffer std::string org.apache.hadoop.record.Buffer
- class type class type class type
- vector<type> std::vector<type> java.util.ArrayList<type>
- map<type,type> std::map<type,type> java.util.TreeMap<type,type>
- </code></pre>
- <h2>Data encodings</h2>
- This section describes the format of the data encodings supported by Hadoop.
- Currently, three data encodings are supported, namely binary, CSV and XML.
- <h3>Binary Serialization Format</h3>
- The binary data encoding format is fairly dense. Serialization of composite
- types is simply defined as a concatenation of serializations of the constituent
- elements (lengths are included in vectors and maps).
- Composite types are serialized as follows:
- <ul>
- <li> class: Sequence of serialized members.
- <li> vector: The number of elements serialized as an int. Followed by a
- sequence of serialized elements.
- <li> map: The number of key value pairs serialized as an int. Followed
- by a sequence of serialized (key,value) pairs.
- </ul>
- Serialization of primitives is more interesting, with a zero compression
- optimization for integral types and normalization to UTF-8 for strings.
- Primitive types are serialized as follows:
- <ul>
- <li> byte: Represented by 1 byte, as is.
- <li> boolean: Represented by 1-byte (0 or 1)
- <li> int/long: Integers and longs are serialized zero compressed.
- Represented as 1-byte if -120 <= value < 128. Otherwise, serialized as a
- sequence of 2-5 bytes for ints, 2-9 bytes for longs. The first byte represents
- the number of trailing bytes, N, as the negative number (-120-N). For example,
- the number 1024 (0x400) is represented by the byte sequence 'x86 x04 x00'.
- This doesn't help much for 4-byte integers but does a reasonably good job with
- longs without bit twiddling.
- <li> float/double: Serialized in IEEE 754 single and double precision
- format in network byte order. This is the format used by Java.
- <li> ustring: Serialized as 4-byte zero compressed length followed by
- data encoded as UTF-8. Strings are normalized to UTF-8 regardless of native
- language representation.
- <li> buffer: Serialized as a 4-byte zero compressed length followed by the
- raw bytes in the buffer.
- </ul>
- <h3>CSV Serialization Format</h3>
- The CSV serialization format has a lot more structure than the "standard"
- Excel CSV format, but we believe the additional structure is useful because
- <ul>
- <li> it makes parsing a lot easier without detracting too much from legibility
- <li> the delimiters around composites make it obvious when one is reading a
- sequence of Hadoop records
- </ul>
- Serialization formats for the various types are detailed in the grammar that
- follows. The notable feature of the formats is the use of delimiters for
- indicating the certain field types.
- <ul>
- <li> A string field begins with a single quote (').
- <li> A buffer field begins with a sharp (#).
- <li> A class, vector or map begins with 's{', 'v{' or 'm{' respectively and
- ends with '}'.
- </ul>
- The CSV format can be described by the following grammar:
- <pre><code>
- record = primitive / struct / vector / map
- primitive = boolean / int / long / float / double / ustring / buffer
- boolean = "T" / "F"
- int = ["-"] 1*DIGIT
- long = ";" ["-"] 1*DIGIT
- float = ["-"] 1*DIGIT "." 1*DIGIT ["E" / "e" ["-"] 1*DIGIT]
- double = ";" ["-"] 1*DIGIT "." 1*DIGIT ["E" / "e" ["-"] 1*DIGIT]
- ustring = "'" *(UTF8 char except NULL, LF, % and , / "%00" / "%0a" / "%25" / "%2c" )
- buffer = "#" *(BYTE except NULL, LF, % and , / "%00" / "%0a" / "%25" / "%2c" )
- struct = "s{" record *("," record) "}"
- vector = "v{" [record *("," record)] "}"
- map = "m{" [*(record "," record)] "}"
- </code></pre>
- <h3>XML Serialization Format</h3>
- The XML serialization format is the same used by Apache XML-RPC
- (http://ws.apache.org/xmlrpc/types.html). This is an extension of the original
- XML-RPC format and adds some additional data types. All record I/O types are
- not directly expressible in this format, and access to a DDL is required in
- order to convert these to valid types. All types primitive or composite are
- represented by <value> elements. The particular XML-RPC type is
- indicated by a nested element in the <value> element. The encoding for
- records is always UTF-8. Primitive types are serialized as follows:
- <ul>
- <li> byte: XML tag <ex:i1>. Values: 1-byte unsigned
- integers represented in US-ASCII
- <li> boolean: XML tag <boolean>. Values: "0" or "1"
- <li> int: XML tags <i4> or <int>. Values: 4-byte
- signed integers represented in US-ASCII.
- <li> long: XML tag <ex:i8>. Values: 8-byte signed integers
- represented in US-ASCII.
- <li> float: XML tag <ex:float>. Values: Single precision
- floating point numbers represented in US-ASCII.
- <li> double: XML tag <double>. Values: Double precision
- floating point numbers represented in US-ASCII.
- <li> ustring: XML tag <;string>. Values: String values
- represented as UTF-8. XML does not permit all Unicode characters in literal
- data. In particular, NULLs and control chars are not allowed. Additionally,
- XML processors are required to replace carriage returns with line feeds and to
- replace CRLF sequences with line feeds. Programming languages that we work
- with do not impose these restrictions on string types. To work around these
- restrictions, disallowed characters and CRs are percent escaped in strings.
- The '%' character is also percent escaped.
- <li> buffer: XML tag <string&>. Values: Arbitrary binary
- data. Represented as hexBinary, each byte is replaced by its 2-byte
- hexadecimal representation.
- </ul>
- Composite types are serialized as follows:
- <ul>
- <li> class: XML tag <struct>. A struct is a sequence of
- <member> elements. Each <member> element has a <name>
- element and a <value> element. The <name> is a string that must
- match /[a-zA-Z][a-zA-Z0-9_]*/. The value of the member is represented
- by a <value> element.
- <li> vector: XML tag <array<. An <array> contains a
- single <data> element. The <data> element is a sequence of
- <value> elements each of which represents an element of the vector.
- <li> map: XML tag <array>. Same as vector.
- </ul>
- For example:
- <pre><code>
- class {
- int MY_INT; // value 5
- vector<float> MY_VEC; // values 0.1, -0.89, 2.45e4
- buffer MY_BUF; // value '\00\n\tabc%'
- }
- </code></pre>
- is serialized as
- <pre><code class="XML">
- <value>
- <struct>
- <member>
- <name>MY_INT</name>
- <value><i4>5</i4></value>
- </member>
- <member>
- <name>MY_VEC</name>
- <value>
- <array>
- <data>
- <value><ex:float>0.1</ex:float></value>
- <value><ex:float>-0.89</ex:float></value>
- <value><ex:float>2.45e4</ex:float></value>
- </data>
- </array>
- </value>
- </member>
- <member>
- <name>MY_BUF</name>
- <value><string>%00\n\tabc%25</string></value>
- </member>
- </struct>
- </value>
- </code></pre>]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.record.compiler">
- <!-- start class org.apache.hadoop.record.compiler.CodeBuffer -->
- <class name="CodeBuffer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A wrapper around StringBuffer that automatically does indentation
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.CodeBuffer -->
- <!-- start class org.apache.hadoop.record.compiler.Consts -->
- <class name="Consts" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <field name="RIO_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RTI_VAR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RTI_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RTI_FILTER_FIELDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RECORD_OUTPUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RECORD_INPUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TAG" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[const definitions for Record I/O compiler
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.Consts -->
- <!-- start class org.apache.hadoop.record.compiler.JBoolean -->
- <class name="JBoolean" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JBoolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JBoolean]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JBoolean -->
- <!-- start class org.apache.hadoop.record.compiler.JBuffer -->
- <class name="JBuffer" extends="org.apache.hadoop.record.compiler.JCompType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JBuffer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JBuffer]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Code generator for "buffer" type.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JBuffer -->
- <!-- start class org.apache.hadoop.record.compiler.JByte -->
- <class name="JByte" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JByte"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Code generator for "byte" type.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JByte -->
- <!-- start class org.apache.hadoop.record.compiler.JDouble -->
- <class name="JDouble" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JDouble"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JDouble]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JDouble -->
- <!-- start class org.apache.hadoop.record.compiler.JField -->
- <class name="JField" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JField" type="java.lang.String, T"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JField]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[A thin wrappper around record field.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JField -->
- <!-- start class org.apache.hadoop.record.compiler.JFile -->
- <class name="JFile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JFile" type="java.lang.String, java.util.ArrayList, java.util.ArrayList"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JFile
- @param name possibly full pathname to the file
- @param inclFiles included files (as JFile)
- @param recList List of records defined within this file]]>
- </doc>
- </constructor>
- <method name="genCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="language" type="java.lang.String"/>
- <param name="destDir" type="java.lang.String"/>
- <param name="options" type="java.util.ArrayList"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Generate record code in given language. Language should be all
- lowercase.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Container for the Hadoop Record DDL.
- The main components of the file are filename, list of included files,
- and records defined in that file.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JFile -->
- <!-- start class org.apache.hadoop.record.compiler.JFloat -->
- <class name="JFloat" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JFloat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JFloat]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JFloat -->
- <!-- start class org.apache.hadoop.record.compiler.JInt -->
- <class name="JInt" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JInt"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JInt]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Code generator for "int" type
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JInt -->
- <!-- start class org.apache.hadoop.record.compiler.JLong -->
- <class name="JLong" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JLong"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JLong]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Code generator for "long" type
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JLong -->
- <!-- start class org.apache.hadoop.record.compiler.JMap -->
- <class name="JMap" extends="org.apache.hadoop.record.compiler.JCompType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JMap" type="org.apache.hadoop.record.compiler.JType, org.apache.hadoop.record.compiler.JType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JMap]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JMap -->
- <!-- start class org.apache.hadoop.record.compiler.JRecord -->
- <class name="JRecord" extends="org.apache.hadoop.record.compiler.JCompType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JRecord" type="java.lang.String, java.util.ArrayList"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JRecord]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JRecord -->
- <!-- start class org.apache.hadoop.record.compiler.JString -->
- <class name="JString" extends="org.apache.hadoop.record.compiler.JCompType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JString"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JString]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JString -->
- <!-- start class org.apache.hadoop.record.compiler.JType -->
- <class name="JType" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Abstract Base class for all types supported by Hadoop Record I/O.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JType -->
- <!-- start class org.apache.hadoop.record.compiler.JVector -->
- <class name="JVector" extends="org.apache.hadoop.record.compiler.JCompType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="JVector" type="org.apache.hadoop.record.compiler.JType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JVector]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JVector -->
- <doc>
- <![CDATA[<p>
- (DEPRECATED) This package contains classes needed for code generation
- from the hadoop record compiler. CppGenerator and JavaGenerator
- are the main entry points from the parser. There are classes
- corrsponding to every primitive type and compound type
- included in Hadoop record I/O syntax.
- </p>
-
- <p>
- DEPRECATED: Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
- </p>]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.record.compiler.ant">
- <!-- start class org.apache.hadoop.record.compiler.ant.RccTask -->
- <class name="RccTask" extends="org.apache.tools.ant.Task"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="RccTask"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of RccTask]]>
- </doc>
- </constructor>
- <method name="setLanguage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="language" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the output language option
- @param language "java"/"c++"]]>
- </doc>
- </method>
- <method name="setFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.io.File"/>
- <doc>
- <![CDATA[Sets the record definition file attribute
- @param file record definition file]]>
- </doc>
- </method>
- <method name="setFailonerror"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="flag" type="boolean"/>
- <doc>
- <![CDATA[Given multiple files (via fileset), set the error handling behavior
- @param flag true will throw build exception in case of failure (default)]]>
- </doc>
- </method>
- <method name="setDestdir"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <doc>
- <![CDATA[Sets directory where output files will be generated
- @param dir output directory]]>
- </doc>
- </method>
- <method name="addFileset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="set" type="org.apache.tools.ant.types.FileSet"/>
- <doc>
- <![CDATA[Adds a fileset that can consist of one or more files
- @param set Set of record definition files]]>
- </doc>
- </method>
- <method name="execute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="BuildException" type="org.apache.tools.ant.BuildException"/>
- <doc>
- <![CDATA[Invoke the Hadoop record compiler on each record definition file]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Hadoop record compiler ant Task
- <p> This task takes the given record definition files and compiles them into
- java or c++
- files. It is then up to the user to compile the generated files.
- <p> The task requires the <code>file</code> or the nested fileset element to be
- specified. Optional attributes are <code>language</code> (set the output
- language, default is "java"),
- <code>destdir</code> (name of the destination directory for generated java/c++
- code, default is ".") and <code>failonerror</code> (specifies error handling
- behavior. default is true).
- <p><h4>Usage</h4>
- <pre>
- <recordcc
- destdir="${basedir}/gensrc"
- language="java">
- <fileset include="**\/*.jr" />
- </recordcc>
- </pre>
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.ant.RccTask -->
- </package>
- <package name="org.apache.hadoop.record.compiler.generated">
- <!-- start class org.apache.hadoop.record.compiler.generated.ParseException -->
- <class name="ParseException" extends="java.lang.Exception"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="ParseException" type="org.apache.hadoop.record.compiler.generated.Token, int[][], java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constructor is used by the method "generateParseException"
- in the generated parser. Calling this constructor generates
- a new object of this type with the fields "currentToken",
- "expectedTokenSequences", and "tokenImage" set. The boolean
- flag "specialConstructor" is also set to true to indicate that
- this constructor was used to create this object.
- This constructor calls its super class with the empty string
- to force the "toString" method of parent class "Throwable" to
- print the error message in the form:
- ParseException: <result of getMessage>]]>
- </doc>
- </constructor>
- <constructor name="ParseException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The following constructors are for use by you for whatever
- purpose you can think of. Constructing the exception in this
- manner makes the exception behave in the normal way - i.e., as
- documented in the class "Throwable". The fields "errorToken",
- "expectedTokenSequences", and "tokenImage" do not contain
- relevant information. The JavaCC generated code does not use
- these constructors.]]>
- </doc>
- </constructor>
- <constructor name="ParseException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This method has the standard behavior when this object has been
- created using the standard constructors. Otherwise, it uses
- "currentToken" and "expectedTokenSequences" to generate a parse
- error message and returns it. If this object has been created
- due to a parse error, and you do not catch it (it gets thrown
- from the parser), then this method is called during the printing
- of the final stack trace, and hence the correct error message
- gets displayed.]]>
- </doc>
- </method>
- <method name="add_escapes" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Used to convert raw characters to their escaped version
- when these raw version cannot be used as part of an ASCII
- string literal.]]>
- </doc>
- </method>
- <field name="specialConstructor" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This variable determines which constructor was used to create
- this object and thereby affects the semantics of the
- "getMessage" method (see below).]]>
- </doc>
- </field>
- <field name="currentToken" type="org.apache.hadoop.record.compiler.generated.Token"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This is the last token that has been consumed successfully. If
- this object has been created due to a parse error, the token
- followng this token will (therefore) be the first error token.]]>
- </doc>
- </field>
- <field name="expectedTokenSequences" type="int[][]"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Each entry in this array is an array of integers. Each array
- of integers represents a sequence of tokens (by their ordinal
- values) that is expected at this point of the parse.]]>
- </doc>
- </field>
- <field name="tokenImage" type="java.lang.String[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This is a reference to the "tokenImage" array of the generated
- parser within which the parse error occurred. This array is
- defined in the generated ...Constants interface.]]>
- </doc>
- </field>
- <field name="eol" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The end of line string for this machine.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This exception is thrown when parse errors are encountered.
- You can explicitly create objects of this exception type by
- calling the method generateParseException in the generated
- parser.
- You can modify this class to customize your error reporting
- mechanisms so long as you retain the public fields.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.ParseException -->
- <!-- start class org.apache.hadoop.record.compiler.generated.Rcc -->
- <class name="Rcc" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <implements name="org.apache.hadoop.record.compiler.generated.RccConstants"/>
- <constructor name="Rcc" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Rcc" type="java.io.InputStream, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Rcc" type="java.io.Reader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Rcc" type="org.apache.hadoop.record.compiler.generated.RccTokenManager"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- </method>
- <method name="usage"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="driver" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- </method>
- <method name="Input" return="org.apache.hadoop.record.compiler.JFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Include" return="org.apache.hadoop.record.compiler.JFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Module" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="ModuleName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="RecordList" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Record" return="org.apache.hadoop.record.compiler.JRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Field" return="org.apache.hadoop.record.compiler.JField"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Type" return="org.apache.hadoop.record.compiler.JType"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Map" return="org.apache.hadoop.record.compiler.JMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Vector" return="org.apache.hadoop.record.compiler.JVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.InputStream"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.InputStream"/>
- <param name="encoding" type="java.lang.String"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.Reader"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tm" type="org.apache.hadoop.record.compiler.generated.RccTokenManager"/>
- </method>
- <method name="getNextToken" return="org.apache.hadoop.record.compiler.generated.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getToken" return="org.apache.hadoop.record.compiler.generated.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="index" type="int"/>
- </method>
- <method name="generateParseException" return="org.apache.hadoop.record.compiler.generated.ParseException"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="enable_tracing"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="disable_tracing"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="token_source" type="org.apache.hadoop.record.compiler.generated.RccTokenManager"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="token" type="org.apache.hadoop.record.compiler.generated.Token"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="jj_nt" type="org.apache.hadoop.record.compiler.generated.Token"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.Rcc -->
- <!-- start interface org.apache.hadoop.record.compiler.generated.RccConstants -->
- <interface name="RccConstants" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <field name="EOF" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MODULE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RECORD_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="INCLUDE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BYTE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BOOLEAN_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="INT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LONG_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FLOAT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DOUBLE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="USTRING_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BUFFER_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VECTOR_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LBRACE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RBRACE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="GT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SEMICOLON_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COMMA_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DOT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CSTRING_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IDENT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WithinOneLineComment" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WithinMultiLineComment" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="tokenImage" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.record.compiler.generated.RccConstants -->
- <!-- start class org.apache.hadoop.record.compiler.generated.RccTokenManager -->
- <class name="RccTokenManager" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <implements name="org.apache.hadoop.record.compiler.generated.RccConstants"/>
- <constructor name="RccTokenManager" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="RccTokenManager" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setDebugStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ds" type="java.io.PrintStream"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"/>
- <param name="lexState" type="int"/>
- </method>
- <method name="SwitchTo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="lexState" type="int"/>
- </method>
- <method name="jjFillToken" return="org.apache.hadoop.record.compiler.generated.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getNextToken" return="org.apache.hadoop.record.compiler.generated.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="debugStream" type="java.io.PrintStream"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="jjstrLiteralImages" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="lexStateNames" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="jjnewLexState" type="int[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="input_stream" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="curChar" type="char"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.RccTokenManager -->
- <!-- start class org.apache.hadoop.record.compiler.generated.SimpleCharStream -->
- <class name="SimpleCharStream" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="SimpleCharStream" type="java.io.Reader, int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.Reader, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.Reader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream, java.lang.String, int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream, int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream, java.lang.String, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setTabSize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- </method>
- <method name="getTabSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- </method>
- <method name="ExpandBuff"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="wrapAround" type="boolean"/>
- </method>
- <method name="FillBuff"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="BeginToken" return="char"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="UpdateLineColumn"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="c" type="char"/>
- </method>
- <method name="readChar" return="char"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getEndColumn" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getEndLine" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getBeginColumn" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getBeginLine" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="backup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="amount" type="int"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.Reader"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- <param name="buffersize" type="int"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.Reader"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.Reader"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- <param name="encoding" type="java.lang.String"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- <param name="buffersize" type="int"/>
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- <param name="buffersize" type="int"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- <param name="encoding" type="java.lang.String"/>
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- <param name="encoding" type="java.lang.String"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- </method>
- <method name="GetImage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="GetSuffix" return="char[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="len" type="int"/>
- </method>
- <method name="Done"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="adjustBeginLineColumn"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newLine" type="int"/>
- <param name="newCol" type="int"/>
- <doc>
- <![CDATA[Method to adjust line and column numbers for the start of a token.]]>
- </doc>
- </method>
- <field name="staticFlag" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="bufpos" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="bufline" type="int[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="bufcolumn" type="int[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="column" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="line" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="prevCharIsCR" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="prevCharIsLF" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="inputStream" type="java.io.Reader"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="buffer" type="char[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="maxNextCharInd" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="inBuf" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="tabSize" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An implementation of interface CharStream, where the stream is assumed to
- contain only ASCII characters (without unicode processing).
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.SimpleCharStream -->
- <!-- start class org.apache.hadoop.record.compiler.generated.Token -->
- <class name="Token" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="Token"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the image.]]>
- </doc>
- </method>
- <method name="newToken" return="org.apache.hadoop.record.compiler.generated.Token"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="ofKind" type="int"/>
- <doc>
- <![CDATA[Returns a new Token object, by default. However, if you want, you
- can create and return subclass objects based on the value of ofKind.
- Simply add the cases to the switch for all those special cases.
- For example, if you have a subclass of Token called IDToken that
- you want to create if ofKind is ID, simlpy add something like :
- case MyParserConstants.ID : return new IDToken();
- to the following switch statement. Then you can cast matchedToken
- variable to the appropriate type and use it in your lexical actions.]]>
- </doc>
- </method>
- <field name="kind" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[An integer that describes the kind of this token. This numbering
- system is determined by JavaCCParser, and a table of these numbers is
- stored in the file ...Constants.java.]]>
- </doc>
- </field>
- <field name="beginLine" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[beginLine and beginColumn describe the position of the first character
- of this token; endLine and endColumn describe the position of the
- last character of this token.]]>
- </doc>
- </field>
- <field name="beginColumn" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[beginLine and beginColumn describe the position of the first character
- of this token; endLine and endColumn describe the position of the
- last character of this token.]]>
- </doc>
- </field>
- <field name="endLine" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[beginLine and beginColumn describe the position of the first character
- of this token; endLine and endColumn describe the position of the
- last character of this token.]]>
- </doc>
- </field>
- <field name="endColumn" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[beginLine and beginColumn describe the position of the first character
- of this token; endLine and endColumn describe the position of the
- last character of this token.]]>
- </doc>
- </field>
- <field name="image" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The string image of the token.]]>
- </doc>
- </field>
- <field name="next" type="org.apache.hadoop.record.compiler.generated.Token"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A reference to the next regular (non-special) token from the input
- stream. If this is the last token from the input stream, or if the
- token manager has not read tokens beyond this one, this field is
- set to null. This is true only if this token is also a regular
- token. Otherwise, see below for a description of the contents of
- this field.]]>
- </doc>
- </field>
- <field name="specialToken" type="org.apache.hadoop.record.compiler.generated.Token"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This field is used to access special tokens that occur prior to this
- token, but after the immediately preceding regular (non-special) token.
- If there are no such special tokens, this field is set to null.
- When there are more than one such special token, this field refers
- to the last of these special tokens, which in turn refers to the next
- previous special token through its specialToken field, and so on
- until the first special token (whose specialToken field is null).
- The next fields of special tokens refer to other special tokens that
- immediately follow it (without an intervening regular token). If there
- is no such token, this field is null.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Describes the input token stream.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.Token -->
- <!-- start class org.apache.hadoop.record.compiler.generated.TokenMgrError -->
- <class name="TokenMgrError" extends="java.lang.Error"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="TokenMgrError"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TokenMgrError" type="java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TokenMgrError" type="boolean, int, int, int, java.lang.String, char, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="addEscapes" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Replaces unprintable characters by their espaced (or unicode escaped)
- equivalents in the given string]]>
- </doc>
- </method>
- <method name="LexicalError" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="EOFSeen" type="boolean"/>
- <param name="lexState" type="int"/>
- <param name="errorLine" type="int"/>
- <param name="errorColumn" type="int"/>
- <param name="errorAfter" type="java.lang.String"/>
- <param name="curChar" type="char"/>
- <doc>
- <![CDATA[Returns a detailed message for the Error when it is thrown by the
- token manager to indicate a lexical error.
- Parameters :
- EOFSeen : indicates if EOF caused the lexicl error
- curLexState : lexical state in which this error occured
- errorLine : line number when the error occured
- errorColumn : column number when the error occured
- errorAfter : prefix that was seen before this error occured
- curchar : the offending character
- Note: You can customize the lexical error message by modifying this method.]]>
- </doc>
- </method>
- <method name="getMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[You can also modify the body of this method to customize your error messages.
- For example, cases like LOOP_DETECTED and INVALID_LEXICAL_STATE are not
- of end-users concern, so you can return something like :
- "Internal Error : Please file a bug report .... "
- from this method for such cases in the release version of your parser.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.TokenMgrError -->
- <doc>
- <![CDATA[<p>
- (DEPRECATED) This package contains code generated by JavaCC from the
- Hadoop record syntax file rcc.jj. For details about the
- record file syntax please @see org.apache.hadoop.record.
- </p>
-
- <p>
- DEPRECATED: Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
- </p>]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.record.meta">
- <!-- start class org.apache.hadoop.record.meta.FieldTypeInfo -->
- <class name="FieldTypeInfo" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <method name="getTypeID" return="org.apache.hadoop.record.meta.TypeID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the field's TypeID object]]>
- </doc>
- </method>
- <method name="getFieldID" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the field's id (name)]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Two FieldTypeInfos are equal if ach of their fields matches]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[We use a basic hashcode implementation, since this class will likely not
- be used as a hashmap key]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ti" type="org.apache.hadoop.record.meta.FieldTypeInfo"/>
- </method>
- <doc>
- <![CDATA[Represents a type information for a field, which is made up of its
- ID (name) and its type (a TypeID object).
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.FieldTypeInfo -->
- <!-- start class org.apache.hadoop.record.meta.MapTypeID -->
- <class name="MapTypeID" extends="org.apache.hadoop.record.meta.TypeID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="MapTypeID" type="org.apache.hadoop.record.meta.TypeID, org.apache.hadoop.record.meta.TypeID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKeyTypeID" return="org.apache.hadoop.record.meta.TypeID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the TypeID of the map's key element]]>
- </doc>
- </method>
- <method name="getValueTypeID" return="org.apache.hadoop.record.meta.TypeID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the TypeID of the map's value element]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Two map typeIDs are equal if their constituent elements have the
- same type]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[We use a basic hashcode implementation, since this class will likely not
- be used as a hashmap key]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Represents typeID for a Map
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.MapTypeID -->
- <!-- start class org.apache.hadoop.record.meta.RecordTypeInfo -->
- <class name="RecordTypeInfo" extends="org.apache.hadoop.record.Record"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="RecordTypeInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an empty RecordTypeInfo object.]]>
- </doc>
- </constructor>
- <constructor name="RecordTypeInfo" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a RecordTypeInfo object representing a record with the given name
- @param name Name of the record]]>
- </doc>
- </constructor>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[return the name of the record]]>
- </doc>
- </method>
- <method name="setName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[set the name of the record]]>
- </doc>
- </method>
- <method name="addField"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fieldName" type="java.lang.String"/>
- <param name="tid" type="org.apache.hadoop.record.meta.TypeID"/>
- <doc>
- <![CDATA[Add a field.
- @param fieldName Name of the field
- @param tid Type ID of the field]]>
- </doc>
- </method>
- <method name="getFieldTypeInfos" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a collection of field type infos]]>
- </doc>
- </method>
- <method name="getNestedStructTypeInfo" return="org.apache.hadoop.record.meta.RecordTypeInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Return the type info of a nested record. We only consider nesting
- to one level.
- @param name Name of the nested record]]>
- </doc>
- </method>
- <method name="serialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rout" type="org.apache.hadoop.record.RecordOutput"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize the type information for a record]]>
- </doc>
- </method>
- <method name="deserialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rin" type="org.apache.hadoop.record.RecordInput"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deserialize the type information for a record]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="peer_" type="java.lang.Object"/>
- <exception name="ClassCastException" type="java.lang.ClassCastException"/>
- <doc>
- <![CDATA[This class doesn't implement Comparable as it's not meant to be used
- for anything besides de/serializing.
- So we always throw an exception.
- Not implemented. Always returns 0 if another RecordTypeInfo is passed in.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A record's Type Information object which can read/write itself.
-
- Type information for a record comprises metadata about the record,
- as well as a collection of type information for each field in the record.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.RecordTypeInfo -->
- <!-- start class org.apache.hadoop.record.meta.StructTypeID -->
- <class name="StructTypeID" extends="org.apache.hadoop.record.meta.TypeID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="StructTypeID" type="org.apache.hadoop.record.meta.RecordTypeInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a StructTypeID based on the RecordTypeInfo of some record]]>
- </doc>
- </constructor>
- <method name="getFieldTypeInfos" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Represents typeID for a struct
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.StructTypeID -->
- <!-- start class org.apache.hadoop.record.meta.TypeID -->
- <class name="TypeID" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <method name="getTypeVal" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type value. One of the constants in RIOType.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Two base typeIDs are equal if they refer to the same type]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[We use a basic hashcode implementation, since this class will likely not
- be used as a hashmap key]]>
- </doc>
- </method>
- <field name="BoolTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant classes for the basic types, so we can share them.]]>
- </doc>
- </field>
- <field name="BufferTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ByteTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DoubleTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FloatTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IntTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LongTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="StringTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="typeVal" type="byte"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Represents typeID for basic types.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.TypeID -->
- <!-- start class org.apache.hadoop.record.meta.Utils -->
- <class name="Utils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <method name="skip"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rin" type="org.apache.hadoop.record.RecordInput"/>
- <param name="tag" type="java.lang.String"/>
- <param name="typeID" type="org.apache.hadoop.record.meta.TypeID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[read/skip bytes from stream based on a type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Various utility functions for Hadooop record I/O platform.
-
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.Utils -->
- <!-- start class org.apache.hadoop.record.meta.VectorTypeID -->
- <class name="VectorTypeID" extends="org.apache.hadoop.record.meta.TypeID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
- <constructor name="VectorTypeID" type="org.apache.hadoop.record.meta.TypeID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getElementTypeID" return="org.apache.hadoop.record.meta.TypeID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Two vector typeIDs are equal if their constituent elements have the
- same type]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[We use a basic hashcode implementation, since this class will likely not
- be used as a hashmap key]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Represents typeID for vector.
- @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.VectorTypeID -->
- </package>
- <package name="org.apache.hadoop.security">
- <!-- start class org.apache.hadoop.security.AccessControlException -->
- <class name="AccessControlException" extends="org.apache.hadoop.fs.permission.AccessControlException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AccessControlException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor is needed for unwrapping from
- {@link org.apache.hadoop.ipc.RemoteException}.]]>
- </doc>
- </constructor>
- <constructor name="AccessControlException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs an {@link AccessControlException}
- with the specified detail message.
- @param s the detail message.]]>
- </doc>
- </constructor>
- <constructor name="AccessControlException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a new exception with the specified cause and a detail
- message of <tt>(cause==null ? null : cause.toString())</tt> (which
- typically contains the class and detail message of <tt>cause</tt>).
- @param cause the cause (which is saved for later retrieval by the
- {@link #getCause()} method). (A <tt>null</tt> value is
- permitted, and indicates that the cause is nonexistent or
- unknown.)]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[An exception class for access control related issues.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.AccessControlException -->
- <!-- start class org.apache.hadoop.security.Credentials -->
- <class name="Credentials" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="Credentials"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an empty credentials instance]]>
- </doc>
- </constructor>
- <constructor name="Credentials" type="org.apache.hadoop.security.Credentials"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a copy of the given credentials
- @param credentials to copy]]>
- </doc>
- </constructor>
- <method name="getToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Returns the Token object for the alias
- @param alias the alias for the Token
- @return token for this alias]]>
- </doc>
- </method>
- <method name="addToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <param name="t" type="org.apache.hadoop.security.token.Token"/>
- <doc>
- <![CDATA[Add a token in the storage (in memory)
- @param alias the alias for the key
- @param t the token object]]>
- </doc>
- </method>
- <method name="getAllTokens" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return all the tokens in the in-memory map]]>
- </doc>
- </method>
- <method name="numberOfTokens" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return number of Tokens in the in-memory map]]>
- </doc>
- </method>
- <method name="getSecretKey" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Returns the key bytes for the alias
- @param alias the alias for the key
- @return key for this alias]]>
- </doc>
- </method>
- <method name="numberOfSecretKeys" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return number of keys in the in-memory map]]>
- </doc>
- </method>
- <method name="addSecretKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <param name="key" type="byte[]"/>
- <doc>
- <![CDATA[Set the key for an alias
- @param alias the alias for the key
- @param key the key bytes]]>
- </doc>
- </method>
- <method name="removeSecretKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Remove the key for a given alias.
- @param alias the alias for the key]]>
- </doc>
- </method>
- <method name="getAllSecretKeys" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return all the secret key entries in the in-memory map]]>
- </doc>
- </method>
- <method name="readTokenStorageFile" return="org.apache.hadoop.security.Credentials"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convenience method for reading a token storage file, and loading the Tokens
- therein in the passed UGI
- @param filename
- @param conf
- @throws IOException]]>
- </doc>
- </method>
- <method name="readTokenStorageFile" return="org.apache.hadoop.security.Credentials"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="java.io.File"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convenience method for reading a token storage file, and loading the Tokens
- therein in the passed UGI
- @param filename
- @param conf
- @throws IOException]]>
- </doc>
- </method>
- <method name="readTokenStorageStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convenience method for reading a token storage file directly from a
- datainputstream]]>
- </doc>
- </method>
- <method name="writeTokenStorageToStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="os" type="java.io.DataOutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeTokenStorageFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Stores all the keys to DataOutput
- @param out
- @throws IOException]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Loads all the keys
- @param in
- @throws IOException]]>
- </doc>
- </method>
- <method name="addAll"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.security.Credentials"/>
- <doc>
- <![CDATA[Copy all of the credentials from one credential object into another.
- Existing secrets and tokens are overwritten.
- @param other the credentials to copy]]>
- </doc>
- </method>
- <method name="mergeAll"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.security.Credentials"/>
- <doc>
- <![CDATA[Copy all of the credentials from one credential object into another.
- Existing secrets and tokens are not overwritten.
- @param other the credentials to copy]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A class that provides the facilities of reading and writing
- secret keys and Tokens.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.Credentials -->
- <!-- start interface org.apache.hadoop.security.GroupMappingServiceProvider -->
- <interface name="GroupMappingServiceProvider" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getGroups" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all various group memberships of a given user.
- Returns EMPTY list in case of non-existing user
- @param user User's name
- @return group memberships of user
- @throws IOException]]>
- </doc>
- </method>
- <method name="cacheGroupsRefresh"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Refresh the cache of groups and user mapping
- @throws IOException]]>
- </doc>
- </method>
- <method name="cacheGroupsAdd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groups" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Caches the group user information
- @param groups list of groups to add to cache
- @throws IOException]]>
- </doc>
- </method>
- <field name="GROUP_MAPPING_CONFIG_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An interface for the implementation of a user-to-groups mapping service
- used by {@link Groups}.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.security.GroupMappingServiceProvider -->
- <!-- start interface org.apache.hadoop.security.IdMappingServiceProvider -->
- <interface name="IdMappingServiceProvider" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getUid" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getGid" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getUserName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uid" type="int"/>
- <param name="unknown" type="java.lang.String"/>
- </method>
- <method name="getGroupName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="gid" type="int"/>
- <param name="unknown" type="java.lang.String"/>
- </method>
- <method name="getUidAllowingUnknown" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- </method>
- <method name="getGidAllowingUnknown" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[An interface for the implementation of <userId, userName> mapping
- and <groupId, groupName> mapping]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.security.IdMappingServiceProvider -->
- <!-- start class org.apache.hadoop.security.KerberosAuthException -->
- <class name="KerberosAuthException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KerberosAuthException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="KerberosAuthException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="KerberosAuthException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setUser"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="u" type="java.lang.String"/>
- </method>
- <method name="setPrincipal"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="java.lang.String"/>
- </method>
- <method name="setKeytabFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="k" type="java.lang.String"/>
- </method>
- <method name="setTicketCacheFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="java.lang.String"/>
- </method>
- <method name="getInitialMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The initial message, or null if not set.]]>
- </doc>
- </method>
- <method name="getKeytabFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The keytab file path, or null if not set.]]>
- </doc>
- </method>
- <method name="getPrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The principal, or null if not set.]]>
- </doc>
- </method>
- <method name="getTicketCacheFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The ticket cache file path, or null if not set.]]>
- </doc>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The user, or null if not set.]]>
- </doc>
- </method>
- <method name="getMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Thrown when {@link UserGroupInformation} failed with an unrecoverable error,
- such as failure in kerberos login/logout, invalid subject etc.
- Caller should not retry when catching this exception.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.KerberosAuthException -->
- <!-- start class org.apache.hadoop.security.SecurityUtil -->
- <class name="SecurityUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="setConfiguration"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="isOriginalTGT" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="ticket" type="javax.security.auth.kerberos.KerberosTicket"/>
- <doc>
- <![CDATA[Check whether the server principal is the TGS's principal
- @param ticket the original TGT (the ticket that is obtained when a
- kinit is done)
- @return true or false]]>
- </doc>
- </method>
- <method name="getServerPrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="principalConfig" type="java.lang.String"/>
- <param name="hostname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert Kerberos principal name pattern to valid Kerberos principal
- names. It replaces hostname pattern with hostname, which should be
- fully-qualified domain name. If hostname is null or "0.0.0.0", it uses
- dynamically looked-up fqdn of the current host instead.
-
- @param principalConfig
- the Kerberos principal name conf value to convert
- @param hostname
- the fully-qualified domain name used for substitution
- @return converted Kerberos principal name
- @throws IOException if the client address cannot be determined]]>
- </doc>
- </method>
- <method name="getServerPrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="principalConfig" type="java.lang.String"/>
- <param name="addr" type="java.net.InetAddress"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert Kerberos principal name pattern to valid Kerberos principal names.
- This method is similar to {@link #getServerPrincipal(String, String)},
- except 1) the reverse DNS lookup from addr to hostname is done only when
- necessary, 2) param addr can't be null (no default behavior of using local
- hostname when addr is null).
-
- @param principalConfig
- Kerberos principal name pattern to convert
- @param addr
- InetAddress of the host used for substitution
- @return converted Kerberos principal name
- @throws IOException if the client address cannot be determined]]>
- </doc>
- </method>
- <method name="login"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="keytabFileKey" type="java.lang.String"/>
- <param name="userNameKey" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Login as a principal specified in config. Substitute $host in
- user's Kerberos principal name with a dynamically looked-up fully-qualified
- domain name of the current host.
-
- @param conf
- conf to use
- @param keytabFileKey
- the key to look for keytab file in conf
- @param userNameKey
- the key to look for user's Kerberos principal name in conf
- @throws IOException if login fails]]>
- </doc>
- </method>
- <method name="login"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="keytabFileKey" type="java.lang.String"/>
- <param name="userNameKey" type="java.lang.String"/>
- <param name="hostname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Login as a principal specified in config. Substitute $host in user's Kerberos principal
- name with hostname. If non-secure mode - return. If no keytab available -
- bail out with an exception
-
- @param conf
- conf to use
- @param keytabFileKey
- the key to look for keytab file in conf
- @param userNameKey
- the key to look for user's Kerberos principal name in conf
- @param hostname
- hostname to use for substitution
- @throws IOException if the config doesn't specify a keytab]]>
- </doc>
- </method>
- <method name="buildDTServiceName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="defPort" type="int"/>
- <doc>
- <![CDATA[create the service name for a Delegation token
- @param uri of the service
- @param defPort is used if the uri lacks a port
- @return the token service, or null if no authority
- @see #buildTokenService(InetSocketAddress)]]>
- </doc>
- </method>
- <method name="getHostFromPrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="principalName" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the host name from the principal name of format <service>/host@realm.
- @param principalName principal name of format as described above
- @return host name if the the string conforms to the above format, else null]]>
- </doc>
- </method>
- <method name="getKerberosInfo" return="org.apache.hadoop.security.KerberosInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Look up the KerberosInfo for a given protocol. It searches all known
- SecurityInfo providers.
- @param protocol the protocol class to get the information for
- @param conf configuration object
- @return the KerberosInfo or null if it has no KerberosInfo defined]]>
- </doc>
- </method>
- <method name="getTokenInfo" return="org.apache.hadoop.security.token.TokenInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Look up the TokenInfo for a given protocol. It searches all known
- SecurityInfo providers.
- @param protocol The protocol class to get the information for.
- @param conf Configuration object
- @return the TokenInfo or null if it has no KerberosInfo defined]]>
- </doc>
- </method>
- <method name="getTokenServiceAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <doc>
- <![CDATA[Decode the given token's service field into an InetAddress
- @param token from which to obtain the service
- @return InetAddress for the service]]>
- </doc>
- </method>
- <method name="setTokenService"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <doc>
- <![CDATA[Set the given token's service to the format expected by the RPC client
- @param token a delegation token
- @param addr the socket for the rpc connection]]>
- </doc>
- </method>
- <method name="buildTokenService" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetSocketAddress"/>
- <doc>
- <![CDATA[Construct the service key for a token
- @param addr InetSocketAddress of remote connection with a token
- @return "ip:port" or "host:port" depending on the value of
- hadoop.security.token.service.use_ip]]>
- </doc>
- </method>
- <method name="buildTokenService" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <doc>
- <![CDATA[Construct the service key for a token
- @param uri of remote connection with a token
- @return "ip:port" or "host:port" depending on the value of
- hadoop.security.token.service.use_ip]]>
- </doc>
- </method>
- <method name="doAsLoginUserOrFatal" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="action" type="java.security.PrivilegedAction"/>
- <doc>
- <![CDATA[Perform the given action as the daemon's login user. If the login
- user cannot be determined, this will log a FATAL error and exit
- the whole JVM.]]>
- </doc>
- </method>
- <method name="doAsLoginUser" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="action" type="java.security.PrivilegedExceptionAction"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Perform the given action as the daemon's login user. If an
- InterruptedException is thrown, it is converted to an IOException.
- @param action the action to perform
- @return the result of the action
- @throws IOException in the event of error]]>
- </doc>
- </method>
- <method name="doAsCurrentUser" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="action" type="java.security.PrivilegedExceptionAction"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Perform the given action as the daemon's current user. If an
- InterruptedException is thrown, it is converted to an IOException.
- @param action the action to perform
- @return the result of the action
- @throws IOException in the event of error]]>
- </doc>
- </method>
- <method name="getAuthenticationMethod" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="setAuthenticationMethod"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="authenticationMethod" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="isPrivilegedPort" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="port" type="int"/>
- </method>
- <field name="LOG" type="org.slf4j.Logger"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HOSTNAME_PATTERN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED_TO_GET_UGI_MSG_HEADER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Security Utils.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.SecurityUtil -->
- <!-- start class org.apache.hadoop.security.UserGroupInformation -->
- <class name="UserGroupInformation" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setShouldRenewImmediatelyForTests"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="immediate" type="boolean"/>
- <doc>
- <![CDATA[For the purposes of unit tests, we want to test login
- from keytab and don't want to wait until the renew
- window (controlled by TICKET_RENEW_WINDOW).
- @param immediate true if we should login without waiting for ticket window]]>
- </doc>
- </method>
- <method name="reattachMetrics"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reattach the class's metrics to a new metric system.]]>
- </doc>
- </method>
- <method name="isInitialized" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConfiguration"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Set the static configuration for UGI.
- In particular, set the security authentication mechanism and the
- group look up service.
- @param conf the configuration to use]]>
- </doc>
- </method>
- <method name="isSecurityEnabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Determine if UserGroupInformation is using Kerberos to determine
- user identities or is relying on simple authentication
-
- @return true if UGI is working in a secure environment]]>
- </doc>
- </method>
- <method name="hasKerberosCredentials" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[checks if logged in using kerberos
- @return true if the subject logged via keytab or has a Kerberos TGT]]>
- </doc>
- </method>
- <method name="getCurrentUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the current user, including any doAs in the current stack.
- @return the current user
- @throws IOException if login fails]]>
- </doc>
- </method>
- <method name="getBestUGI" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ticketCachePath" type="java.lang.String"/>
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Find the most appropriate UserGroupInformation to use
- @param ticketCachePath The Kerberos ticket cache path, or NULL
- if none is specfied
- @param user The user name, or NULL if none is specified.
- @return The most appropriate UserGroupInformation]]>
- </doc>
- </method>
- <method name="getUGIFromTicketCache" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ticketCache" type="java.lang.String"/>
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a UserGroupInformation from a Kerberos ticket cache.
-
- @param user The principal name to load from the ticket
- cache
- @param ticketCache the path to the ticket cache file
- @throws IOException if the kerberos login fails]]>
- </doc>
- </method>
- <method name="getUGIFromSubject" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="subject" type="javax.security.auth.Subject"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a UserGroupInformation from a Subject with Kerberos principal.
- @param subject The KerberosPrincipal to use in UGI
- @throws IOException
- @throws KerberosAuthException if the kerberos login fails]]>
- </doc>
- </method>
- <method name="getLoginUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the currently logged in user.
- @return the logged in user
- @throws IOException if login fails]]>
- </doc>
- </method>
- <method name="trimLoginMethod" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="userName" type="java.lang.String"/>
- <doc>
- <![CDATA[remove the login method that is followed by a space from the username
- e.g. "jack (auth:SIMPLE)" -> "jack"
- @param userName
- @return userName without login method]]>
- </doc>
- </method>
- <method name="loginUserFromSubject"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="subject" type="javax.security.auth.Subject"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Log in a user using the given subject
- @param subject the subject to use when logging in a user, or null to
- create a new subject.
- @throws IOException if login fails]]>
- </doc>
- </method>
- <method name="isFromKeytab" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is this user logged in from a keytab file?
- @return true if the credentials are from a keytab file.]]>
- </doc>
- </method>
- <method name="loginUserFromKeytab"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Log a user in from a keytab file. Loads a user identity from a keytab
- file and logs them in. They become the currently logged-in user.
- @param user the principal name to load from the keytab
- @param path the path to the keytab file
- @throws IOException
- @throws KerberosAuthException if it's a kerberos login exception.]]>
- </doc>
- </method>
- <method name="logoutUserFromKeytab"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Log the current user out who previously logged in using keytab.
- This method assumes that the user logged in by calling
- {@link #loginUserFromKeytab(String, String)}.
- @throws IOException
- @throws KerberosAuthException if a failure occurred in logout,
- or if the user did not log in by invoking loginUserFromKeyTab() before.]]>
- </doc>
- </method>
- <method name="checkTGTAndReloginFromKeytab"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Re-login a user from keytab if TGT is expired or is close to expiry.
-
- @throws IOException
- @throws KerberosAuthException if it's a kerberos login exception.]]>
- </doc>
- </method>
- <method name="reloginFromKeytab"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Re-Login a user in from a keytab file. Loads a user identity from a keytab
- file and logs them in. They become the currently logged-in user. This
- method assumes that {@link #loginUserFromKeytab(String, String)} had
- happened already.
- The Subject field of this UserGroupInformation object is updated to have
- the new credentials.
- @throws IOException
- @throws KerberosAuthException on a failure]]>
- </doc>
- </method>
- <method name="reloginFromTicketCache"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Re-Login a user in from the ticket cache. This
- method assumes that login had happened already.
- The Subject field of this UserGroupInformation object is updated to have
- the new credentials.
- @throws IOException
- @throws KerberosAuthException on a failure]]>
- </doc>
- </method>
- <method name="loginUserFromKeytabAndReturnUGI" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Log a user in from a keytab file. Loads a user identity from a keytab
- file and login them in. This new user does not affect the currently
- logged-in user.
- @param user the principal name to load from the keytab
- @param path the path to the keytab file
- @throws IOException if the keytab file can't be read]]>
- </doc>
- </method>
- <method name="isLoginKeytabBased" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Did the login happen via keytab
- @return true or false]]>
- </doc>
- </method>
- <method name="isLoginTicketBased" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Did the login happen via ticket cache
- @return true or false]]>
- </doc>
- </method>
- <method name="createRemoteUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a user from a login name. It is intended to be used for remote
- users in RPC, since it won't have any credentials.
- @param user the full user principal name, must not be empty or null
- @return the UserGroupInformation for the remote user.]]>
- </doc>
- </method>
- <method name="createRemoteUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="authMethod" type="org.apache.hadoop.security.SaslRpcServer.AuthMethod"/>
- <doc>
- <![CDATA[Create a user from a login name. It is intended to be used for remote
- users in RPC, since it won't have any credentials.
- @param user the full user principal name, must not be empty or null
- @return the UserGroupInformation for the remote user.]]>
- </doc>
- </method>
- <method name="createProxyUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="realUser" type="org.apache.hadoop.security.UserGroupInformation"/>
- <doc>
- <![CDATA[Create a proxy user using username of the effective user and the ugi of the
- real user.
- @param user
- @param realUser
- @return proxyUser ugi]]>
- </doc>
- </method>
- <method name="getRealUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get RealUser (vs. EffectiveUser)
- @return realUser running over proxy user]]>
- </doc>
- </method>
- <method name="createUserForTesting" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="userGroups" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Create a UGI for testing HDFS and MapReduce
- @param user the full user principal name
- @param userGroups the names of the groups that the user belongs to
- @return a fake user for running unit tests]]>
- </doc>
- </method>
- <method name="createProxyUserForTesting" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="realUser" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="userGroups" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Create a proxy user UGI for testing HDFS and MapReduce
-
- @param user
- the full user principal name for effective user
- @param realUser
- UGI of the real user
- @param userGroups
- the names of the groups that the user belongs to
- @return a fake user for running unit tests]]>
- </doc>
- </method>
- <method name="getShortUserName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user's login name.
- @return the user's name up to the first '/' or '@'.]]>
- </doc>
- </method>
- <method name="getPrimaryGroupName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getUserName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user's full principal name.
- @return the user's full principal name.]]>
- </doc>
- </method>
- <method name="addTokenIdentifier" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tokenId" type="org.apache.hadoop.security.token.TokenIdentifier"/>
- <doc>
- <![CDATA[Add a TokenIdentifier to this UGI. The TokenIdentifier has typically been
- authenticated by the RPC layer as belonging to the user represented by this
- UGI.
-
- @param tokenId
- tokenIdentifier to be added
- @return true on successful add of new tokenIdentifier]]>
- </doc>
- </method>
- <method name="getTokenIdentifiers" return="java.util.Set"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the set of TokenIdentifiers belonging to this UGI
-
- @return the set of TokenIdentifiers belonging to this UGI]]>
- </doc>
- </method>
- <method name="addToken" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <doc>
- <![CDATA[Add a token to this UGI
-
- @param token Token to be added
- @return true on successful add of new token]]>
- </doc>
- </method>
- <method name="addToken" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <doc>
- <![CDATA[Add a named token to this UGI
-
- @param alias Name of the token
- @param token Token to be added
- @return true on successful add of new token]]>
- </doc>
- </method>
- <method name="getTokens" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the collection of tokens associated with this user.
-
- @return an unmodifiable collection of tokens associated with user]]>
- </doc>
- </method>
- <method name="getCredentials" return="org.apache.hadoop.security.Credentials"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the tokens in credentials form associated with this user.
-
- @return Credentials of tokens associated with this user]]>
- </doc>
- </method>
- <method name="addCredentials"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <doc>
- <![CDATA[Add the given Credentials to this user.
- @param credentials of tokens and secrets]]>
- </doc>
- </method>
- <method name="getGroupNames" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the group names for this user. {@link #getGroups()} is less
- expensive alternative when checking for a contained element.
- @return the list of users with the primary group first. If the command
- fails, it returns an empty list.]]>
- </doc>
- </method>
- <method name="getGroups" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the group names for this user.
- @return the list of users with the primary group first. If the command
- fails, it returns an empty list.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the username.]]>
- </doc>
- </method>
- <method name="setAuthenticationMethod"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="authMethod" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"/>
- <doc>
- <![CDATA[Sets the authentication method in the subject
-
- @param authMethod]]>
- </doc>
- </method>
- <method name="setAuthenticationMethod"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="authMethod" type="org.apache.hadoop.security.SaslRpcServer.AuthMethod"/>
- <doc>
- <![CDATA[Sets the authentication method in the subject
-
- @param authMethod]]>
- </doc>
- </method>
- <method name="getAuthenticationMethod" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the authentication method from the subject
-
- @return AuthenticationMethod in the subject, null if not present.]]>
- </doc>
- </method>
- <method name="getRealAuthenticationMethod" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the authentication method from the real user's subject. If there
- is no real user, return the given user's authentication method.
-
- @return AuthenticationMethod in the subject, null if not present.]]>
- </doc>
- </method>
- <method name="getRealAuthenticationMethod" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
- <doc>
- <![CDATA[Returns the authentication method of a ugi. If the authentication method is
- PROXY, returns the authentication method of the real user.
-
- @param ugi
- @return AuthenticationMethod]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compare the subjects to see if they are equal to each other.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the hash of the subject.]]>
- </doc>
- </method>
- <method name="getSubject" return="javax.security.auth.Subject"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the underlying subject from this ugi.
- @return the subject that represents this user.]]>
- </doc>
- </method>
- <method name="doAs" return="T"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="action" type="java.security.PrivilegedAction"/>
- <doc>
- <![CDATA[Run the given action as the user.
- @param <T> the return type of the run method
- @param action the method to execute
- @return the value from the run method]]>
- </doc>
- </method>
- <method name="doAs" return="T"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="action" type="java.security.PrivilegedExceptionAction"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Run the given action as the user, potentially throwing an exception.
- @param <T> the return type of the run method
- @param action the method to execute
- @return the value from the run method
- @throws IOException if the action throws an IOException
- @throws Error if the action throws an Error
- @throws RuntimeException if the action throws a RuntimeException
- @throws InterruptedException if the action throws an InterruptedException
- @throws UndeclaredThrowableException if the action throws something else]]>
- </doc>
- </method>
- <method name="logAllUserInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Log all (current, real, login) UGI and token info into UGI debug log.
- @param ugi - UGI
- @throws IOException]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[A test method to print out the current user's UGI.
- @param args if there are two arguments, read the user from the keytab
- and print it out.
- @throws Exception]]>
- </doc>
- </method>
- <field name="HADOOP_TOKEN_FILE_LOCATION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Environment variable pointing to the token cache file]]>
- </doc>
- </field>
- <doc>
- <![CDATA[User and group information for Hadoop.
- This class wraps around a JAAS Subject and provides methods to determine the
- user's username and groups. It supports both the Windows, Unix and Kerberos
- login modules.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.UserGroupInformation -->
- <!-- start class org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod -->
- <class name="UserGroupInformation.AuthenticationMethod" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getAuthMethod" return="org.apache.hadoop.security.SaslRpcServer.AuthMethod"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="authMethod" type="org.apache.hadoop.security.SaslRpcServer.AuthMethod"/>
- </method>
- <doc>
- <![CDATA[existing types of authentications' methods]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod -->
- </package>
- <package name="org.apache.hadoop.security.alias">
- <!-- start class org.apache.hadoop.security.alias.CredentialProvider -->
- <class name="CredentialProvider" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CredentialProvider"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="isTransient" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Indicates whether this provider represents a store
- that is intended for transient use - such as the UserProvider
- is. These providers are generally used to provide job access to
- passwords rather than for long term storage.
- @return true if transient, false otherwise]]>
- </doc>
- </method>
- <method name="flush"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Ensures that any changes to the credentials are written to persistent
- store.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getCredentialEntry" return="org.apache.hadoop.security.alias.CredentialProvider.CredentialEntry"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the credential entry for a specific alias.
- @param alias the name of a specific credential
- @return the credentialEntry
- @throws IOException]]>
- </doc>
- </method>
- <method name="getAliases" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the aliases for all credentials.
- @return the list of alias names
- @throws IOException]]>
- </doc>
- </method>
- <method name="createCredentialEntry" return="org.apache.hadoop.security.alias.CredentialProvider.CredentialEntry"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="credential" type="char[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a new credential. The given alias must not already exist.
- @param name the alias of the credential
- @param credential the credential value for the alias.
- @throws IOException]]>
- </doc>
- </method>
- <method name="deleteCredentialEntry"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the given credential.
- @param name the alias of the credential to delete
- @throws IOException]]>
- </doc>
- </method>
- <method name="needsPassword" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Does this provider require a password? This means that a password is
- required for normal operation, and it has not been found through normal
- means. If true, the password should be provided by the caller using
- setPassword().
- @return Whether or not the provider requires a password
- @throws IOException]]>
- </doc>
- </method>
- <method name="noPasswordWarning" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If a password for the provider is needed, but is not provided, this will
- return a warning and instructions for supplying said password to the
- provider.
- @return A warning and instructions for supplying the password]]>
- </doc>
- </method>
- <method name="noPasswordError" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If a password for the provider is needed, but is not provided, this will
- return an error message and instructions for supplying said password to
- the provider.
- @return An error message and instructions for supplying the password]]>
- </doc>
- </method>
- <field name="CLEAR_TEXT_FALLBACK" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A provider of credentials or password for Hadoop applications. Provides an
- abstraction to separate credential storage from users of them. It
- is intended to support getting or storing passwords in a variety of ways,
- including third party bindings.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.alias.CredentialProvider -->
- <!-- start class org.apache.hadoop.security.alias.CredentialProviderFactory -->
- <class name="CredentialProviderFactory" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CredentialProviderFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createProvider" return="org.apache.hadoop.security.alias.CredentialProvider"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="providerName" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getProviders" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="CREDENTIAL_PROVIDER_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A factory to create a list of CredentialProvider based on the path given in a
- Configuration. It uses a service loader interface to find the available
- CredentialProviders and create them based on the list of URIs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.alias.CredentialProviderFactory -->
- </package>
- <package name="org.apache.hadoop.security.authorize">
- <!-- start class org.apache.hadoop.security.authorize.AccessControlList -->
- <class name="AccessControlList" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="AccessControlList"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constructor exists primarily for AccessControlList to be Writable.]]>
- </doc>
- </constructor>
- <constructor name="AccessControlList" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a new ACL from a String representation of the same.
-
- The String is a a comma separated list of users and groups.
- The user list comes first and is separated by a space followed
- by the group list. For e.g. "user1,user2 group1,group2"
-
- @param aclString String representation of the ACL]]>
- </doc>
- </constructor>
- <constructor name="AccessControlList" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a new ACL from String representation of users and groups
-
- The arguments are comma separated lists
-
- @param users comma separated list of users
- @param groups comma separated list of groups]]>
- </doc>
- </constructor>
- <method name="isAllAllowed" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="addUser"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <doc>
- <![CDATA[Add user to the names of users allowed for this service.
-
- @param user
- The user name]]>
- </doc>
- </method>
- <method name="addGroup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <doc>
- <![CDATA[Add group to the names of groups allowed for this service.
-
- @param group
- The group name]]>
- </doc>
- </method>
- <method name="removeUser"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <doc>
- <![CDATA[Remove user from the names of users allowed for this service.
-
- @param user
- The user name]]>
- </doc>
- </method>
- <method name="removeGroup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <doc>
- <![CDATA[Remove group from the names of groups allowed for this service.
-
- @param group
- The group name]]>
- </doc>
- </method>
- <method name="getUsers" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the names of users allowed for this service.
- @return the set of user names. the set must not be modified.]]>
- </doc>
- </method>
- <method name="getGroups" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the names of user groups allowed for this service.
- @return the set of group names. the set must not be modified.]]>
- </doc>
- </method>
- <method name="isUserInList" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
- <doc>
- <![CDATA[Checks if a user represented by the provided {@link UserGroupInformation}
- is a member of the Access Control List
- @param ugi UserGroupInformation to check if contained in the ACL
- @return true if ugi is member of the list]]>
- </doc>
- </method>
- <method name="isUserAllowed" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns descriptive way of users and groups that are part of this ACL.
- Use {@link #getAclString()} to get the exact String that can be given to
- the constructor of AccessControlList to create a new instance.]]>
- </doc>
- </method>
- <method name="getAclString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the access control list as a String that can be used for building a
- new instance by sending it to the constructor of {@link AccessControlList}.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serializes the AccessControlList object]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deserializes the AccessControlList object]]>
- </doc>
- </method>
- <field name="WILDCARD_ACL_VALUE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Class representing a configured access control list.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authorize.AccessControlList -->
- <!-- start class org.apache.hadoop.security.authorize.AuthorizationException -->
- <class name="AuthorizationException" extends="org.apache.hadoop.security.AccessControlException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AuthorizationException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="AuthorizationException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="AuthorizationException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a new exception with the specified cause and a detail
- message of <tt>(cause==null ? null : cause.toString())</tt> (which
- typically contains the class and detail message of <tt>cause</tt>).
- @param cause the cause (which is saved for later retrieval by the
- {@link #getCause()} method). (A <tt>null</tt> value is
- permitted, and indicates that the cause is nonexistent or
- unknown.)]]>
- </doc>
- </constructor>
- <method name="getStackTrace" return="java.lang.StackTraceElement[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="printStackTrace"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="printStackTrace"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.io.PrintStream"/>
- </method>
- <method name="printStackTrace"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.io.PrintWriter"/>
- </method>
- <doc>
- <![CDATA[An exception class for authorization-related issues.
-
- This class <em>does not</em> provide the stack trace for security purposes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authorize.AuthorizationException -->
- <!-- start class org.apache.hadoop.security.authorize.DefaultImpersonationProvider -->
- <class name="DefaultImpersonationProvider" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.authorize.ImpersonationProvider"/>
- <constructor name="DefaultImpersonationProvider"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTestProvider" return="org.apache.hadoop.security.authorize.DefaultImpersonationProvider"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="configurationPrefix" type="java.lang.String"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="authorize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="remoteAddress" type="java.lang.String"/>
- <exception name="AuthorizationException" type="org.apache.hadoop.security.authorize.AuthorizationException"/>
- </method>
- <method name="getProxySuperuserUserConfKey" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="userName" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns configuration key for effective usergroups allowed for a superuser
-
- @param userName name of the superuser
- @return configuration key for superuser usergroups]]>
- </doc>
- </method>
- <method name="getProxySuperuserGroupConfKey" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="userName" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns configuration key for effective groups allowed for a superuser
-
- @param userName name of the superuser
- @return configuration key for superuser groups]]>
- </doc>
- </method>
- <method name="getProxySuperuserIpConfKey" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="userName" type="java.lang.String"/>
- <doc>
- <![CDATA[Return configuration key for superuser ip addresses
-
- @param userName name of the superuser
- @return configuration key for superuser ip-addresses]]>
- </doc>
- </method>
- <method name="getProxyGroups" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProxyHosts" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.security.authorize.DefaultImpersonationProvider -->
- <!-- start interface org.apache.hadoop.security.authorize.ImpersonationProvider -->
- <interface name="ImpersonationProvider" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="configurationPrefix" type="java.lang.String"/>
- <doc>
- <![CDATA[Specifies the configuration prefix for the proxy user properties and
- initializes the provider.
- @param configurationPrefix the configuration prefix for the proxy user
- properties]]>
- </doc>
- </method>
- <method name="authorize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="remoteAddress" type="java.lang.String"/>
- <exception name="AuthorizationException" type="org.apache.hadoop.security.authorize.AuthorizationException"/>
- <doc>
- <![CDATA[Authorize the superuser which is doing doAs
-
- @param user ugi of the effective or proxy user which contains a real user
- @param remoteAddress the ip address of client
- @throws AuthorizationException]]>
- </doc>
- </method>
- </interface>
- <!-- end interface org.apache.hadoop.security.authorize.ImpersonationProvider -->
- </package>
- <package name="org.apache.hadoop.security.http">
- <!-- start class org.apache.hadoop.security.http.RestCsrfPreventionFilter -->
- <class name="RestCsrfPreventionFilter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="javax.servlet.Filter"/>
- <constructor name="RestCsrfPreventionFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filterConfig" type="javax.servlet.FilterConfig"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- <method name="isBrowser" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="userAgent" type="java.lang.String"/>
- <doc>
- <![CDATA[This method interrogates the User-Agent String and returns whether it
- refers to a browser. If its not a browser, then the requirement for the
- CSRF header will not be enforced; if it is a browser, the requirement will
- be enforced.
- <p>
- A User-Agent String is considered to be a browser if it matches
- any of the regex patterns from browser-useragent-regex; the default
- behavior is to consider everything a browser that matches the following:
- "^Mozilla.*,^Opera.*". Subclasses can optionally override
- this method to use different behavior.
- @param userAgent The User-Agent String, or null if there isn't one
- @return true if the User-Agent String refers to a browser, false if not]]>
- </doc>
- </method>
- <method name="handleHttpInteraction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="httpInteraction" type="org.apache.hadoop.security.http.RestCsrfPreventionFilter.HttpInteraction"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <doc>
- <![CDATA[Handles an {@link HttpInteraction} by applying the filtering logic.
- @param httpInteraction caller's HTTP interaction
- @throws IOException if there is an I/O error
- @throws ServletException if the implementation relies on the servlet API
- and a servlet API call has failed]]>
- </doc>
- </method>
- <method name="doFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.ServletRequest"/>
- <param name="response" type="javax.servlet.ServletResponse"/>
- <param name="chain" type="javax.servlet.FilterChain"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- <method name="destroy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFilterParams" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="confPrefix" type="java.lang.String"/>
- <doc>
- <![CDATA[Constructs a mapping of configuration properties to be used for filter
- initialization. The mapping includes all properties that start with the
- specified configuration prefix. Property names in the mapping are trimmed
- to remove the configuration prefix.
- @param conf configuration to read
- @param confPrefix configuration prefix
- @return mapping of configuration properties to be used for filter
- initialization]]>
- </doc>
- </method>
- <field name="HEADER_USER_AGENT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BROWSER_USER_AGENT_PARAM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CUSTOM_HEADER_PARAM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CUSTOM_METHODS_TO_IGNORE_PARAM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HEADER_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This filter provides protection against cross site request forgery (CSRF)
- attacks for REST APIs. Enabling this filter on an endpoint results in the
- requirement of all client to send a particular (configurable) HTTP header
- with every request. In the absense of this header the filter will reject the
- attempt as a bad request.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.http.RestCsrfPreventionFilter -->
- <!-- start class org.apache.hadoop.security.http.XFrameOptionsFilter -->
- <class name="XFrameOptionsFilter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="javax.servlet.Filter"/>
- <constructor name="XFrameOptionsFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="destroy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="doFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="req" type="javax.servlet.ServletRequest"/>
- <param name="res" type="javax.servlet.ServletResponse"/>
- <param name="chain" type="javax.servlet.FilterChain"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="javax.servlet.FilterConfig"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- <method name="getFilterParams" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="confPrefix" type="java.lang.String"/>
- <doc>
- <![CDATA[Constructs a mapping of configuration properties to be used for filter
- initialization. The mapping includes all properties that start with the
- specified configuration prefix. Property names in the mapping are trimmed
- to remove the configuration prefix.
- @param conf configuration to read
- @param confPrefix configuration prefix
- @return mapping of configuration properties to be used for filter
- initialization]]>
- </doc>
- </method>
- <field name="X_FRAME_OPTIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CUSTOM_HEADER_PARAM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This filter protects webapps from clickjacking attacks that
- are possible through use of Frames to embed the resources in another
- application and intercept clicks to accomplish nefarious things.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.http.XFrameOptionsFilter -->
- </package>
- <package name="org.apache.hadoop.security.protocolPB">
- </package>
- <package name="org.apache.hadoop.security.ssl">
- </package>
- <package name="org.apache.hadoop.security.token">
- <!-- start class org.apache.hadoop.security.token.SecretManager -->
- <class name="SecretManager" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SecretManager"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createPassword" return="byte[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="identifier" type="T"/>
- <doc>
- <![CDATA[Create the password for the given identifier.
- identifier may be modified inside this method.
- @param identifier the identifier to use
- @return the new password]]>
- </doc>
- </method>
- <method name="retrievePassword" return="byte[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="T"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- <doc>
- <![CDATA[Retrieve the password for the given token identifier. Should check the date
- or registry to make sure the token hasn't expired or been revoked. Returns
- the relevant password.
- @param identifier the identifier to validate
- @return the password to use
- @throws InvalidToken the token was invalid]]>
- </doc>
- </method>
- <method name="retriableRetrievePassword" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="T"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- <exception name="StandbyException" type="org.apache.hadoop.ipc.StandbyException"/>
- <exception name="RetriableException" type="org.apache.hadoop.ipc.RetriableException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The same functionality with {@link #retrievePassword}, except that this
- method can throw a {@link RetriableException} or a {@link StandbyException}
- to indicate that client can retry/failover the same operation because of
- temporary issue on the server side.
-
- @param identifier the identifier to validate
- @return the password to use
- @throws InvalidToken the token was invalid
- @throws StandbyException the server is in standby state, the client can
- try other servers
- @throws RetriableException the token was invalid, and the server thinks
- this may be a temporary issue and suggests the client to retry
- @throws IOException to allow future exceptions to be added without breaking
- compatibility]]>
- </doc>
- </method>
- <method name="createIdentifier" return="T"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an empty token identifier.
- @return the newly created empty token identifier]]>
- </doc>
- </method>
- <method name="checkAvailableForRead"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="StandbyException" type="org.apache.hadoop.ipc.StandbyException"/>
- <doc>
- <![CDATA[No-op if the secret manager is available for reading tokens, throw a
- StandbyException otherwise.
-
- @throws StandbyException if the secret manager is not available to read
- tokens]]>
- </doc>
- </method>
- <method name="generateSecret" return="javax.crypto.SecretKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Generate a new random secret key.
- @return the new key]]>
- </doc>
- </method>
- <method name="createPassword" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="byte[]"/>
- <param name="key" type="javax.crypto.SecretKey"/>
- <doc>
- <![CDATA[Compute HMAC of the identifier using the secret key and return the
- output as password
- @param identifier the bytes of the identifier
- @param key the secret key
- @return the bytes of the generated password]]>
- </doc>
- </method>
- <method name="createSecretKey" return="javax.crypto.SecretKey"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <doc>
- <![CDATA[Convert the byte[] to a secret key
- @param key the byte[] to create a secret key from
- @return the secret key]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The server-side secret manager for each token type.
- @param <T> The type of the token identifier]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.SecretManager -->
- <!-- start class org.apache.hadoop.security.token.Token -->
- <class name="Token" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="Token" type="T, org.apache.hadoop.security.token.SecretManager"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a token given a token identifier and a secret manager for the
- type of the token identifier.
- @param id the token identifier
- @param mgr the secret manager]]>
- </doc>
- </constructor>
- <constructor name="Token" type="byte[], byte[], org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a token from the components.
- @param identifier the token identifier
- @param password the token's password
- @param kind the kind of token
- @param service the service for this token]]>
- </doc>
- </constructor>
- <constructor name="Token"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor]]>
- </doc>
- </constructor>
- <constructor name="Token" type="org.apache.hadoop.security.token.Token"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clone a token.
- @param other the token to clone]]>
- </doc>
- </constructor>
- <method name="getIdentifier" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token identifier's byte representation
- @return the token identifier's byte representation]]>
- </doc>
- </method>
- <method name="decodeIdentifier" return="T"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the token identifier object, or null if it could not be constructed
- (because the class could not be loaded, for example).
- @return the token identifier, or null
- @throws IOException]]>
- </doc>
- </method>
- <method name="getPassword" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token password/secret
- @return the token password/secret]]>
- </doc>
- </method>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token kind
- @return the kind of the token]]>
- </doc>
- </method>
- <method name="getService" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the service on which the token is supposed to be used
- @return the service name]]>
- </doc>
- </method>
- <method name="setService"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newService" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Set the service on which the token is supposed to be used
- @param newService the service name]]>
- </doc>
- </method>
- <method name="setID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- </method>
- <method name="setPassword"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newPassword" type="byte[]"/>
- </method>
- <method name="isPrivate" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether this is a private token.
- @return false always for non-private tokens]]>
- </doc>
- </method>
- <method name="isPrivateCloneOf" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="thePublicService" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Whether this is a private clone of a public token.
- @param thePublicService the public service name
- @return false always for non-private tokens]]>
- </doc>
- </method>
- <method name="privateClone" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newService" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Create a private clone of a public token.
- @param newService the new service name
- @return a private token]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="encodeToUrlString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Encode this token as a url safe string
- @return the encoded string
- @throws IOException]]>
- </doc>
- </method>
- <method name="decodeFromUrlString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newValue" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Decode the given url safe string into this token.
- @param newValue the encoded string
- @throws IOException]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="right" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="buildCacheKey" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isManaged" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Is this token managed so that it can be renewed or cancelled?
- @return true, if it can be renewed and cancelled.]]>
- </doc>
- </method>
- <method name="renew" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Renew this delegation token
- @return the new expiration time
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="cancel"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Cancel this delegation token
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <field name="LOG" type="org.slf4j.Logger"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The client-side form of the token.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.Token -->
- <!-- start class org.apache.hadoop.security.token.Token.TrivialRenewer -->
- <class name="Token.TrivialRenewer" extends="org.apache.hadoop.security.token.TokenRenewer"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Token.TrivialRenewer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="handleKind" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="kind" type="org.apache.hadoop.io.Text"/>
- </method>
- <method name="isManaged" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- </method>
- <method name="renew" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="cancel"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <doc>
- <![CDATA[A trivial renewer for token kinds that aren't managed. Sub-classes need
- to implement getKind for their token kind.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.Token.TrivialRenewer -->
- <!-- start class org.apache.hadoop.security.token.TokenIdentifier -->
- <class name="TokenIdentifier" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="TokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token kind
- @return the kind of the token]]>
- </doc>
- </method>
- <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Ugi with the username encoded in the token identifier
-
- @return the username. null is returned if username in the identifier is
- empty or null.]]>
- </doc>
- </method>
- <method name="getBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the bytes for the token identifier
- @return the bytes of the identifier]]>
- </doc>
- </method>
- <method name="getTrackingId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a tracking identifier that can be used to associate usages of a
- token across multiple client sessions.
- Currently, this function just returns an MD5 of {{@link #getBytes()}.
- @return tracking identifier]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An identifier that identifies a token, may contain public information
- about a token, including its kind (or type).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.TokenIdentifier -->
- <!-- start class org.apache.hadoop.security.token.TokenInfo -->
- <class name="TokenInfo" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <doc>
- <![CDATA[Indicates Token related information to be used]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.TokenInfo -->
- <!-- start class org.apache.hadoop.security.token.TokenRenewer -->
- <class name="TokenRenewer" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TokenRenewer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="handleKind" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="kind" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Does this renewer handle this kind of token?
- @param kind the kind of the token
- @return true if this renewer can renew it]]>
- </doc>
- </method>
- <method name="isManaged" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Is the given token managed? Only managed tokens may be renewed or
- cancelled.
- @param token the token being checked
- @return true if the token may be renewed or cancelled
- @throws IOException]]>
- </doc>
- </method>
- <method name="renew" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Renew the given token.
- @return the new expiration time
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="cancel"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Cancel the given token
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is the interface for plugins that handle tokens.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.TokenRenewer -->
- <!-- start interface org.apache.hadoop.security.token.TokenSelector -->
- <interface name="TokenSelector" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="selectToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.io.Text"/>
- <param name="tokens" type="java.util.Collection"/>
- </method>
- <doc>
- <![CDATA[Select token of type T from tokens for use with named service
-
- @param <T>
- T extends TokenIdentifier]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.security.token.TokenSelector -->
- </package>
- <package name="org.apache.hadoop.security.token.delegation.web">
- <!-- start class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL -->
- <class name="DelegationTokenAuthenticatedURL" extends="org.apache.hadoop.security.authentication.client.AuthenticatedURL"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DelegationTokenAuthenticatedURL"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an <code>DelegationTokenAuthenticatedURL</code>.
- <p/>
- An instance of the default {@link DelegationTokenAuthenticator} will be
- used.]]>
- </doc>
- </constructor>
- <constructor name="DelegationTokenAuthenticatedURL" type="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an <code>DelegationTokenAuthenticatedURL</code>.
- @param authenticator the {@link DelegationTokenAuthenticator} instance to
- use, if <code>null</code> the default one will be used.]]>
- </doc>
- </constructor>
- <constructor name="DelegationTokenAuthenticatedURL" type="org.apache.hadoop.security.authentication.client.ConnectionConfigurator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an <code>DelegationTokenAuthenticatedURL</code> using the default
- {@link DelegationTokenAuthenticator} class.
- @param connConfigurator a connection configurator.]]>
- </doc>
- </constructor>
- <constructor name="DelegationTokenAuthenticatedURL" type="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticator, org.apache.hadoop.security.authentication.client.ConnectionConfigurator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an <code>DelegationTokenAuthenticatedURL</code>.
- @param authenticator the {@link DelegationTokenAuthenticator} instance to
- use, if <code>null</code> the default one will be used.
- @param connConfigurator a connection configurator.]]>
- </doc>
- </constructor>
- <method name="setDefaultDelegationTokenAuthenticator"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="authenticator" type="java.lang.Class"/>
- <doc>
- <![CDATA[Sets the default {@link DelegationTokenAuthenticator} class to use when an
- {@link DelegationTokenAuthenticatedURL} instance is created without
- specifying one.
- The default class is {@link KerberosDelegationTokenAuthenticator}
- @param authenticator the authenticator class to use as default.]]>
- </doc>
- </method>
- <method name="getDefaultDelegationTokenAuthenticator" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the default {@link DelegationTokenAuthenticator} class to use when
- an {@link DelegationTokenAuthenticatedURL} instance is created without
- specifying one.
- <p/>
- The default class is {@link KerberosDelegationTokenAuthenticator}
- @return the delegation token authenticator class to use as default.]]>
- </doc>
- </method>
- <method name="setUseQueryStringForDelegationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="useQueryString" type="boolean"/>
- <doc>
- <![CDATA[Sets if delegation token should be transmitted in the URL query string.
- By default it is transmitted using the
- {@link DelegationTokenAuthenticator#DELEGATION_TOKEN_HEADER} HTTP header.
- <p/>
- This method is provided to enable WebHDFS backwards compatibility.
- @param useQueryString <code>TRUE</code> if the token is transmitted in the
- URL query string, <code>FALSE</code> if the delegation token is transmitted
- using the {@link DelegationTokenAuthenticator#DELEGATION_TOKEN_HEADER} HTTP
- header.]]>
- </doc>
- </method>
- <method name="useQueryStringForDelegationToken" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns if delegation token is transmitted as a HTTP header.
- @return <code>TRUE</code> if the token is transmitted in the URL query
- string, <code>FALSE</code> if the delegation token is transmitted using the
- {@link DelegationTokenAuthenticator#DELEGATION_TOKEN_HEADER} HTTP header.]]>
- </doc>
- </method>
- <method name="openConnection" return="java.net.HttpURLConnection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Returns an authenticated {@link HttpURLConnection}, it uses a Delegation
- Token only if the given auth token is an instance of {@link Token} and
- it contains a Delegation Token, otherwise use the configured
- {@link DelegationTokenAuthenticator} to authenticate the connection.
- @param url the URL to connect to. Only HTTP/S URLs are supported.
- @param token the authentication token being used for the user.
- @return an authenticated {@link HttpURLConnection}.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="openConnection" return="java.net.HttpURLConnection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Returns an authenticated {@link HttpURLConnection}. If the Delegation
- Token is present, it will be used taking precedence over the configured
- <code>Authenticator</code>.
- @param url the URL to connect to. Only HTTP/S URLs are supported.
- @param token the authentication token being used for the user.
- @return an authenticated {@link HttpURLConnection}.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="openConnection" return="java.net.HttpURLConnection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL.Token"/>
- <param name="doAs" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Returns an authenticated {@link HttpURLConnection}. If the Delegation
- Token is present, it will be used taking precedence over the configured
- <code>Authenticator</code>. If the <code>doAs</code> parameter is not NULL,
- the request will be done on behalf of the specified <code>doAs</code> user.
- @param url the URL to connect to. Only HTTP/S URLs are supported.
- @param token the authentication token being used for the user.
- @param doAs user to do the the request on behalf of, if NULL the request is
- as self.
- @return an authenticated {@link HttpURLConnection}.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL.Token"/>
- <param name="renewer" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Requests a delegation token using the configured <code>Authenticator</code>
- for authentication.
- @param url the URL to get the delegation token from. Only HTTP/S URLs are
- supported.
- @param token the authentication token being used for the user where the
- Delegation token will be stored.
- @param renewer the renewer user.
- @return a delegation token.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL.Token"/>
- <param name="renewer" type="java.lang.String"/>
- <param name="doAsUser" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Requests a delegation token using the configured <code>Authenticator</code>
- for authentication.
- @param url the URL to get the delegation token from. Only HTTP/S URLs are
- supported.
- @param token the authentication token being used for the user where the
- Delegation token will be stored.
- @param renewer the renewer user.
- @param doAsUser the user to do as, which will be the token owner.
- @return a delegation token.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="renewDelegationToken" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Renews a delegation token from the server end-point using the
- configured <code>Authenticator</code> for authentication.
- @param url the URL to renew the delegation token from. Only HTTP/S URLs are
- supported.
- @param token the authentication token with the Delegation Token to renew.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="renewDelegationToken" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL.Token"/>
- <param name="doAsUser" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Renews a delegation token from the server end-point using the
- configured <code>Authenticator</code> for authentication.
- @param url the URL to renew the delegation token from. Only HTTP/S URLs are
- supported.
- @param token the authentication token with the Delegation Token to renew.
- @param doAsUser the user to do as, which will be the token owner.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="cancelDelegationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Cancels a delegation token from the server end-point. It does not require
- being authenticated by the configured <code>Authenticator</code>.
- @param url the URL to cancel the delegation token from. Only HTTP/S URLs
- are supported.
- @param token the authentication token with the Delegation Token to cancel.
- @throws IOException if an IO error occurred.]]>
- </doc>
- </method>
- <method name="cancelDelegationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL.Token"/>
- <param name="doAsUser" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Cancels a delegation token from the server end-point. It does not require
- being authenticated by the configured <code>Authenticator</code>.
- @param url the URL to cancel the delegation token from. Only HTTP/S URLs
- are supported.
- @param token the authentication token with the Delegation Token to cancel.
- @param doAsUser the user to do as, which will be the token owner.
- @throws IOException if an IO error occurred.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The <code>DelegationTokenAuthenticatedURL</code> is a
- {@link AuthenticatedURL} sub-class with built-in Hadoop Delegation Token
- functionality.
- <p/>
- The authentication mechanisms supported by default are Hadoop Simple
- authentication (also known as pseudo authentication) and Kerberos SPNEGO
- authentication.
- <p/>
- Additional authentication mechanisms can be supported via {@link
- DelegationTokenAuthenticator} implementations.
- <p/>
- The default {@link DelegationTokenAuthenticator} is the {@link
- KerberosDelegationTokenAuthenticator} class which supports
- automatic fallback from Kerberos SPNEGO to Hadoop Simple authentication via
- the {@link PseudoDelegationTokenAuthenticator} class.
- <p/>
- <code>AuthenticatedURL</code> instances are not thread-safe.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL -->
- <!-- start class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL.Token -->
- <class name="DelegationTokenAuthenticatedURL.Token" extends="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DelegationTokenAuthenticatedURL.Token"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setDelegationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delegationToken" type="org.apache.hadoop.security.token.Token"/>
- </method>
- <doc>
- <![CDATA[Client side authentication token that handles Delegation Tokens.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticatedURL.Token -->
- <!-- start class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticator -->
- <class name="DelegationTokenAuthenticator" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.authentication.client.Authenticator"/>
- <constructor name="DelegationTokenAuthenticator" type="org.apache.hadoop.security.authentication.client.Authenticator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConnectionConfigurator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="configurator" type="org.apache.hadoop.security.authentication.client.ConnectionConfigurator"/>
- </method>
- <method name="authenticate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <param name="renewer" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Requests a delegation token using the configured <code>Authenticator</code>
- for authentication.
- @param url the URL to get the delegation token from. Only HTTP/S URLs are
- supported.
- @param token the authentication token being used for the user where the
- Delegation token will be stored.
- @param renewer the renewer user.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <param name="renewer" type="java.lang.String"/>
- <param name="doAsUser" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Requests a delegation token using the configured <code>Authenticator</code>
- for authentication.
- @param url the URL to get the delegation token from. Only HTTP/S URLs are
- supported.
- @param token the authentication token being used for the user where the
- Delegation token will be stored.
- @param renewer the renewer user.
- @param doAsUser the user to do as, which will be the token owner.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="renewDelegationToken" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <param name="dToken" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Renews a delegation token from the server end-point using the
- configured <code>Authenticator</code> for authentication.
- @param url the URL to renew the delegation token from. Only HTTP/S URLs are
- supported.
- @param token the authentication token with the Delegation Token to renew.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="renewDelegationToken" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <param name="dToken" type="org.apache.hadoop.security.token.Token"/>
- <param name="doAsUser" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Renews a delegation token from the server end-point using the
- configured <code>Authenticator</code> for authentication.
- @param url the URL to renew the delegation token from. Only HTTP/S URLs are
- supported.
- @param token the authentication token with the Delegation Token to renew.
- @param doAsUser the user to do as, which will be the token owner.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="cancelDelegationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <param name="dToken" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Cancels a delegation token from the server end-point. It does not require
- being authenticated by the configured <code>Authenticator</code>.
- @param url the URL to cancel the delegation token from. Only HTTP/S URLs
- are supported.
- @param token the authentication token with the Delegation Token to cancel.
- @throws IOException if an IO error occurred.]]>
- </doc>
- </method>
- <method name="cancelDelegationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <param name="dToken" type="org.apache.hadoop.security.token.Token"/>
- <param name="doAsUser" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Cancels a delegation token from the server end-point. It does not require
- being authenticated by the configured <code>Authenticator</code>.
- @param url the URL to cancel the delegation token from. Only HTTP/S URLs
- are supported.
- @param token the authentication token with the Delegation Token to cancel.
- @param doAsUser the user to do as, which will be the token owner.
- @throws IOException if an IO error occurred.]]>
- </doc>
- </method>
- <field name="OP_PARAM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_HEADER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_PARAM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TOKEN_PARAM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RENEWER_PARAM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SERVICE_PARAM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_JSON" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_URL_STRING_JSON" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RENEW_DELEGATION_TOKEN_JSON" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[{@link Authenticator} wrapper that enhances an {@link Authenticator} with
- Delegation Token support.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticator -->
- <!-- start class org.apache.hadoop.security.token.delegation.web.KerberosDelegationTokenAuthenticator -->
- <class name="KerberosDelegationTokenAuthenticator" extends="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticator"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KerberosDelegationTokenAuthenticator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[The <code>KerberosDelegationTokenAuthenticator</code> provides support for
- Kerberos SPNEGO authentication mechanism and support for Hadoop Delegation
- Token operations.
- <p/>
- It falls back to the {@link PseudoDelegationTokenAuthenticator} if the HTTP
- endpoint does not trigger a SPNEGO authentication]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.delegation.web.KerberosDelegationTokenAuthenticator -->
- <!-- start class org.apache.hadoop.security.token.delegation.web.PseudoDelegationTokenAuthenticator -->
- <class name="PseudoDelegationTokenAuthenticator" extends="org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticator"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PseudoDelegationTokenAuthenticator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[The <code>PseudoDelegationTokenAuthenticator</code> provides support for
- Hadoop's pseudo authentication mechanism that accepts
- the user name specified as a query string parameter and support for Hadoop
- Delegation Token operations.
- <p/>
- This mimics the model of Hadoop Simple authentication trusting the
- {@link UserGroupInformation#getCurrentUser()} value.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.delegation.web.PseudoDelegationTokenAuthenticator -->
- </package>
- <package name="org.apache.hadoop.service">
- <!-- start class org.apache.hadoop.service.AbstractService -->
- <class name="AbstractService" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.service.Service"/>
- <constructor name="AbstractService" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the service.
- @param name service name]]>
- </doc>
- </constructor>
- <method name="getServiceState" return="org.apache.hadoop.service.Service.STATE"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFailureCause" return="java.lang.Throwable"
- abstract="false" native="false" synchronized="true"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFailureState" return="org.apache.hadoop.service.Service.STATE"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConfig"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Set the configuration for this service.
- This method is called during {@link #init(Configuration)}
- and should only be needed if for some reason a service implementation
- needs to override that initial setting -for example replacing
- it with a new subclass of {@link Configuration}
- @param conf new configuration.]]>
- </doc>
- </method>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[{@inheritDoc}
- This invokes {@link #serviceInit}
- @param conf the configuration of the service. This must not be null
- @throws ServiceStateException if the configuration was null,
- the state change not permitted, or something else went wrong]]>
- </doc>
- </method>
- <method name="start"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}
- @throws ServiceStateException if the current service state does not permit
- this action]]>
- </doc>
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Relay to {@link #stop()}
- @throws IOException]]>
- </doc>
- </method>
- <method name="noteFailure"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <param name="exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Failure handling: record the exception
- that triggered it -if there was not one already.
- Services are free to call this themselves.
- @param exception the exception]]>
- </doc>
- </method>
- <method name="waitForServiceToStop" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="timeout" type="long"/>
- </method>
- <method name="serviceInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[All initialization code needed by a service.
- This method will only ever be called once during the lifecycle of
- a specific service instance.
- Implementations do not need to be synchronized as the logic
- in {@link #init(Configuration)} prevents re-entrancy.
- The base implementation checks to see if the subclass has created
- a new configuration instance, and if so, updates the base class value
- @param conf configuration
- @throws Exception on a failure -these will be caught,
- possibly wrapped, and wil; trigger a service stop]]>
- </doc>
- </method>
- <method name="serviceStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Actions called during the INITED to STARTED transition.
- This method will only ever be called once during the lifecycle of
- a specific service instance.
- Implementations do not need to be synchronized as the logic
- in {@link #start()} prevents re-entrancy.
- @throws Exception if needed -these will be caught,
- wrapped, and trigger a service stop]]>
- </doc>
- </method>
- <method name="serviceStop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Actions called during the transition to the STOPPED state.
- This method will only ever be called once during the lifecycle of
- a specific service instance.
- Implementations do not need to be synchronized as the logic
- in {@link #stop()} prevents re-entrancy.
- Implementations MUST write this to be robust against failures, including
- checks for null references -and for the first failure to not stop other
- attempts to shut down parts of the service.
- @throws Exception if needed -these will be caught and logged.]]>
- </doc>
- </method>
- <method name="registerServiceListener"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="org.apache.hadoop.service.ServiceStateChangeListener"/>
- </method>
- <method name="unregisterServiceListener"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="org.apache.hadoop.service.ServiceStateChangeListener"/>
- </method>
- <method name="registerGlobalListener"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="org.apache.hadoop.service.ServiceStateChangeListener"/>
- <doc>
- <![CDATA[Register a global listener, which receives notifications
- from the state change events of all services in the JVM
- @param l listener]]>
- </doc>
- </method>
- <method name="unregisterGlobalListener" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="org.apache.hadoop.service.ServiceStateChangeListener"/>
- <doc>
- <![CDATA[unregister a global listener.
- @param l listener to unregister
- @return true if the listener was found (and then deleted)]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getConfig" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLifecycleHistory" return="java.util.List"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isInState" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="expected" type="org.apache.hadoop.service.Service.STATE"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="putBlocker"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="details" type="java.lang.String"/>
- <doc>
- <![CDATA[Put a blocker to the blocker map -replacing any
- with the same name.
- @param name blocker name
- @param details any specifics on the block. This must be non-null.]]>
- </doc>
- </method>
- <method name="removeBlocker"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Remove a blocker from the blocker map -
- this is a no-op if the blocker is not present
- @param name the name of the blocker]]>
- </doc>
- </method>
- <method name="getBlockers" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This is the base implementation class for services.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.service.AbstractService -->
- <!-- start class org.apache.hadoop.service.CompositeService -->
- <class name="CompositeService" extends="org.apache.hadoop.service.AbstractService"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CompositeService" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getServices" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a cloned list of services
- @return a list of child services at the time of invocation -
- added services will not be picked up.]]>
- </doc>
- </method>
- <method name="addService"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.service.Service"/>
- <doc>
- <![CDATA[Add the passed {@link Service} to the list of services managed by this
- {@link CompositeService}
- @param service the {@link Service} to be added]]>
- </doc>
- </method>
- <method name="addIfService" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="object" type="java.lang.Object"/>
- <doc>
- <![CDATA[If the passed object is an instance of {@link Service},
- add it to the list of services managed by this {@link CompositeService}
- @param object
- @return true if a service is added, false otherwise.]]>
- </doc>
- </method>
- <method name="removeService" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.service.Service"/>
- </method>
- <method name="serviceInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="serviceStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="serviceStop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <field name="STOP_ONLY_STARTED_SERVICES" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Policy on shutdown: attempt to close everything (purest) or
- only try to close started services (which assumes
- that the service implementations may not handle the stop() operation
- except when started.
- Irrespective of this policy, if a child service fails during
- its init() or start() operations, it will have stop() called on it.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Composition of services.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.service.CompositeService -->
- <!-- start class org.apache.hadoop.service.LifecycleEvent -->
- <class name="LifecycleEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Serializable"/>
- <constructor name="LifecycleEvent"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="time" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Local time in milliseconds when the event occurred]]>
- </doc>
- </field>
- <field name="state" type="org.apache.hadoop.service.Service.STATE"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[new state]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A serializable lifecycle event: the time a state
- transition occurred, and what state was entered.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.service.LifecycleEvent -->
- <!-- start class org.apache.hadoop.service.LoggingStateChangeListener -->
- <class name="LoggingStateChangeListener" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.service.ServiceStateChangeListener"/>
- <constructor name="LoggingStateChangeListener" type="org.slf4j.Logger"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Log events to the given log
- @param log destination for events]]>
- </doc>
- </constructor>
- <constructor name="LoggingStateChangeListener"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Log events to the static log for this class]]>
- </doc>
- </constructor>
- <method name="stateChanged"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.service.Service"/>
- <doc>
- <![CDATA[Callback for a state change event: log it
- @param service the service that has changed.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is a state change listener that logs events at INFO level]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.service.LoggingStateChangeListener -->
- <!-- start interface org.apache.hadoop.service.Service -->
- <interface name="Service" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Initialize the service.
- The transition MUST be from {@link STATE#NOTINITED} to {@link STATE#INITED}
- unless the operation failed and an exception was raised, in which case
- {@link #stop()} MUST be invoked and the service enter the state
- {@link STATE#STOPPED}.
- @param config the configuration of the service
- @throws RuntimeException on any failure during the operation]]>
- </doc>
- </method>
- <method name="start"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Start the service.
- The transition MUST be from {@link STATE#INITED} to {@link STATE#STARTED}
- unless the operation failed and an exception was raised, in which case
- {@link #stop()} MUST be invoked and the service enter the state
- {@link STATE#STOPPED}.
- @throws RuntimeException on any failure during the operation]]>
- </doc>
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stop the service. This MUST be a no-op if the service is already
- in the {@link STATE#STOPPED} state. It SHOULD be a best-effort attempt
- to stop all parts of the service.
- The implementation must be designed to complete regardless of the service
- state, including the initialized/uninitialized state of all its internal
- fields.
- @throws RuntimeException on any failure during the stop operation]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A version of stop() that is designed to be usable in Java7 closure
- clauses.
- Implementation classes MUST relay this directly to {@link #stop()}
- @throws IOException never
- @throws RuntimeException on any failure during the stop operation]]>
- </doc>
- </method>
- <method name="registerServiceListener"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="listener" type="org.apache.hadoop.service.ServiceStateChangeListener"/>
- <doc>
- <![CDATA[Register a listener to the service state change events.
- If the supplied listener is already listening to this service,
- this method is a no-op.
- @param listener a new listener]]>
- </doc>
- </method>
- <method name="unregisterServiceListener"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="listener" type="org.apache.hadoop.service.ServiceStateChangeListener"/>
- <doc>
- <![CDATA[Unregister a previously registered listener of the service state
- change events. No-op if the listener is already unregistered.
- @param listener the listener to unregister.]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of this service.
- @return the service name]]>
- </doc>
- </method>
- <method name="getConfig" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the configuration of this service.
- This is normally not a clone and may be manipulated, though there are no
- guarantees as to what the consequences of such actions may be
- @return the current configuration, unless a specific implentation chooses
- otherwise.]]>
- </doc>
- </method>
- <method name="getServiceState" return="org.apache.hadoop.service.Service.STATE"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current service state
- @return the state of the service]]>
- </doc>
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the service start time
- @return the start time of the service. This will be zero if the service
- has not yet been started.]]>
- </doc>
- </method>
- <method name="isInState" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="state" type="org.apache.hadoop.service.Service.STATE"/>
- <doc>
- <![CDATA[Query to see if the service is in a specific state.
- In a multi-threaded system, the state may not hold for very long.
- @param state the expected state
- @return true if, at the time of invocation, the service was in that state.]]>
- </doc>
- </method>
- <method name="getFailureCause" return="java.lang.Throwable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the first exception raised during the service failure. If null,
- no exception was logged
- @return the failure logged during a transition to the stopped state]]>
- </doc>
- </method>
- <method name="getFailureState" return="org.apache.hadoop.service.Service.STATE"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the state in which the failure in {@link #getFailureCause()} occurred.
- @return the state or null if there was no failure]]>
- </doc>
- </method>
- <method name="waitForServiceToStop" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timeout" type="long"/>
- <doc>
- <![CDATA[Block waiting for the service to stop; uses the termination notification
- object to do so.
- This method will only return after all the service stop actions
- have been executed (to success or failure), or the timeout elapsed
- This method can be called before the service is inited or started; this is
- to eliminate any race condition with the service stopping before
- this event occurs.
- @param timeout timeout in milliseconds. A value of zero means "forever"
- @return true iff the service stopped in the time period]]>
- </doc>
- </method>
- <method name="getLifecycleHistory" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a snapshot of the lifecycle history; it is a static list
- @return a possibly empty but never null list of lifecycle events.]]>
- </doc>
- </method>
- <method name="getBlockers" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the blockers on a service -remote dependencies
- that are stopping the service from being <i>live</i>.
- @return a (snapshotted) map of blocker name->description values]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Service LifeCycle.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.service.Service -->
- <!-- start class org.apache.hadoop.service.ServiceOperations -->
- <class name="ServiceOperations" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.service.Service"/>
- <doc>
- <![CDATA[Stop a service.
- <p/>Do nothing if the service is null or not
- in a state in which it can be/needs to be stopped.
- <p/>
- The service state is checked <i>before</i> the operation begins.
- This process is <i>not</i> thread safe.
- @param service a service or null]]>
- </doc>
- </method>
- <method name="stopQuietly" return="java.lang.Exception"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.service.Service"/>
- <doc>
- <![CDATA[Stop a service; if it is null do nothing. Exceptions are caught and
- logged at warn level. (but not Throwables). This operation is intended to
- be used in cleanup operations
- @param service a service; may be null
- @return any exception that was caught; null if none was.]]>
- </doc>
- </method>
- <method name="stopQuietly" return="java.lang.Exception"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="log" type="org.apache.commons.logging.Log"/>
- <param name="service" type="org.apache.hadoop.service.Service"/>
- <doc>
- <![CDATA[Stop a service; if it is null do nothing. Exceptions are caught and
- logged at warn level. (but not Throwables). This operation is intended to
- be used in cleanup operations
- @param log the log to warn at
- @param service a service; may be null
- @return any exception that was caught; null if none was.
- @see ServiceOperations#stopQuietly(Service)]]>
- </doc>
- </method>
- <method name="stopQuietly" return="java.lang.Exception"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="log" type="org.slf4j.Logger"/>
- <param name="service" type="org.apache.hadoop.service.Service"/>
- <doc>
- <![CDATA[Stop a service; if it is null do nothing. Exceptions are caught and
- logged at warn level. (but not Throwables). This operation is intended to
- be used in cleanup operations
- @param log the log to warn at
- @param service a service; may be null
- @return any exception that was caught; null if none was.
- @see ServiceOperations#stopQuietly(Service)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class contains a set of methods to work with services, especially
- to walk them through their lifecycle.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.service.ServiceOperations -->
- <!-- start interface org.apache.hadoop.service.ServiceStateChangeListener -->
- <interface name="ServiceStateChangeListener" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="stateChanged"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.service.Service"/>
- <doc>
- <![CDATA[Callback to notify of a state change. The service will already
- have changed state before this callback is invoked.
- This operation is invoked on the thread that initiated the state change,
- while the service itself in in a sychronized section.
- <ol>
- <li>Any long-lived operation here will prevent the service state
- change from completing in a timely manner.</li>
- <li>If another thread is somehow invoked from the listener, and
- that thread invokes the methods of the service (including
- subclass-specific methods), there is a risk of a deadlock.</li>
- </ol>
- @param service the service that has changed.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface to notify state changes of a service.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.service.ServiceStateChangeListener -->
- <!-- start class org.apache.hadoop.service.ServiceStateException -->
- <class name="ServiceStateException" extends="java.lang.RuntimeException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.ExitCodeProvider"/>
- <constructor name="ServiceStateException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Instantiate
- @param message error message]]>
- </doc>
- </constructor>
- <constructor name="ServiceStateException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Instantiate with a message and cause; if the cause has an exit code
- then it is used, otherwise the generic
- {@link LauncherExitCodes#EXIT_SERVICE_LIFECYCLE_EXCEPTION} exit code
- is used.
- @param message exception message
- @param cause optional inner cause]]>
- </doc>
- </constructor>
- <constructor name="ServiceStateException" type="int, java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Instantiate, using the specified exit code as the exit code
- of the exception, irrespetive of any exit code supplied by any inner
- cause.
- @param exitCode exit code to declare
- @param message exception message
- @param cause inner cause]]>
- </doc>
- </constructor>
- <constructor name="ServiceStateException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getExitCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="convert" return="java.lang.RuntimeException"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fault" type="java.lang.Throwable"/>
- <doc>
- <![CDATA[Convert any exception into a {@link RuntimeException}.
- All other exception types are wrapped in a new instance of
- {@code ServiceStateException}.
- @param fault exception or throwable
- @return a {@link RuntimeException} to rethrow]]>
- </doc>
- </method>
- <method name="convert" return="java.lang.RuntimeException"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="text" type="java.lang.String"/>
- <param name="fault" type="java.lang.Throwable"/>
- <doc>
- <![CDATA[Convert any exception into a {@link RuntimeException}.
- If the caught exception is already of that type, it is typecast to a
- {@link RuntimeException} and returned.
- All other exception types are wrapped in a new instance of
- {@code ServiceStateException}.
- @param text text to use if a new exception is created
- @param fault exception or throwable
- @return a {@link RuntimeException} to rethrow]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Exception that can be raised on state change operations, whose
- exit code can be explicitly set, determined from that of any nested
- cause, or a default value of
- {@link LauncherExitCodes#EXIT_SERVICE_LIFECYCLE_EXCEPTION}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.service.ServiceStateException -->
- <!-- start class org.apache.hadoop.service.ServiceStateModel -->
- <class name="ServiceStateModel" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ServiceStateModel" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create the service state model in the {@link Service.STATE#NOTINITED}
- state.]]>
- </doc>
- </constructor>
- <constructor name="ServiceStateModel" type="java.lang.String, org.apache.hadoop.service.Service.STATE"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a service state model instance in the chosen state
- @param state the starting state]]>
- </doc>
- </constructor>
- <method name="getState" return="org.apache.hadoop.service.Service.STATE"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Query the service state. This is a non-blocking operation.
- @return the state]]>
- </doc>
- </method>
- <method name="isInState" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="proposed" type="org.apache.hadoop.service.Service.STATE"/>
- <doc>
- <![CDATA[Query that the state is in a specific state
- @param proposed proposed new state
- @return the state]]>
- </doc>
- </method>
- <method name="ensureCurrentState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="expectedState" type="org.apache.hadoop.service.Service.STATE"/>
- <doc>
- <![CDATA[Verify that that a service is in a given state.
- @param expectedState the desired state
- @throws ServiceStateException if the service state is different from
- the desired state]]>
- </doc>
- </method>
- <method name="enterState" return="org.apache.hadoop.service.Service.STATE"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="proposed" type="org.apache.hadoop.service.Service.STATE"/>
- <doc>
- <![CDATA[Enter a state -thread safe.
- @param proposed proposed new state
- @return the original state
- @throws ServiceStateException if the transition is not permitted]]>
- </doc>
- </method>
- <method name="checkStateTransition"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="state" type="org.apache.hadoop.service.Service.STATE"/>
- <param name="proposed" type="org.apache.hadoop.service.Service.STATE"/>
- <doc>
- <![CDATA[Check that a state tansition is valid and
- throw an exception if not
- @param name name of the service (can be null)
- @param state current state
- @param proposed proposed new state]]>
- </doc>
- </method>
- <method name="isValidStateTransition" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="current" type="org.apache.hadoop.service.Service.STATE"/>
- <param name="proposed" type="org.apache.hadoop.service.Service.STATE"/>
- <doc>
- <![CDATA[Is a state transition valid?
- There are no checks for current==proposed
- as that is considered a non-transition.
- using an array kills off all branch misprediction costs, at the expense
- of cache line misses.
- @param current current state
- @param proposed proposed new state
- @return true if the transition to a new state is valid]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[return the state text as the toString() value
- @return the current state's description]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implements the service state model.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.service.ServiceStateModel -->
- </package>
- <package name="org.apache.hadoop.service.launcher">
- <!-- start class org.apache.hadoop.service.launcher.AbstractLaunchableService -->
- <class name="AbstractLaunchableService" extends="org.apache.hadoop.service.AbstractService"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.service.launcher.LaunchableService"/>
- <constructor name="AbstractLaunchableService" type="java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct an instance with the given name.]]>
- </doc>
- </constructor>
- <method name="bindArgs" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="org.apache.hadoop.conf.Configuration"/>
- <param name="args" type="java.util.List"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[{@inheritDoc}
- <p>
- The base implementation logs all arguments at the debug level,
- then returns the passed in config unchanged.]]>
- </doc>
- </method>
- <method name="execute" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[{@inheritDoc}
- <p>
- The action is to signal success by returning the exit code 0.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Subclass of {@link AbstractService} that provides basic implementations
- of the {@link LaunchableService} methods.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.service.launcher.AbstractLaunchableService -->
- <!-- start class org.apache.hadoop.service.launcher.HadoopUncaughtExceptionHandler -->
- <class name="HadoopUncaughtExceptionHandler" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Thread.UncaughtExceptionHandler"/>
- <constructor name="HadoopUncaughtExceptionHandler" type="java.lang.Thread.UncaughtExceptionHandler"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an instance delegating to the supplied handler if
- the exception is considered "simple".
- @param delegate a delegate exception handler.]]>
- </doc>
- </constructor>
- <constructor name="HadoopUncaughtExceptionHandler"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Basic exception handler -logs simple exceptions, then continues.]]>
- </doc>
- </constructor>
- <method name="uncaughtException"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="thread" type="java.lang.Thread"/>
- <param name="exception" type="java.lang.Throwable"/>
- <doc>
- <![CDATA[Uncaught exception handler.
- If an error is raised: shutdown
- The state of the system is unknown at this point -attempting
- a clean shutdown is dangerous. Instead: exit
- @param thread thread that failed
- @param exception the raised exception]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class is intended to be installed by calling
- {@link Thread#setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler)}
- in the main entry point.
- The base class will always attempt to shut down the process if an Error
- was raised; the behavior on a standard Exception, raised outside
- process shutdown, is simply to log it.
- (Based on the class {@code YarnUncaughtExceptionHandler})]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.service.launcher.HadoopUncaughtExceptionHandler -->
- <!-- start interface org.apache.hadoop.service.launcher.LaunchableService -->
- <interface name="LaunchableService" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.service.Service"/>
- <method name="bindArgs" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="org.apache.hadoop.conf.Configuration"/>
- <param name="args" type="java.util.List"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Propagate the command line arguments.
- <p>
- This method is called before {@link #init(Configuration)};
- Any non-null configuration that is returned from this operation
- becomes the one that is passed on to that {@link #init(Configuration)}
- operation.
- <p>
- This permits implementations to change the configuration before
- the init operation. As the ServiceLauncher only creates
- an instance of the base {@link Configuration} class, it is
- recommended to instantiate any subclass (such as YarnConfiguration)
- that injects new resources.
- <p>
- @param config the initial configuration build up by the
- service launcher.
- @param args list of arguments passed to the command line
- after any launcher-specific commands have been stripped.
- @return the configuration to init the service with.
- Recommended: pass down the config parameter with any changes
- @throws Exception any problem]]>
- </doc>
- </method>
- <method name="execute" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Run a service. This method is called after {@link Service#start()}.
- <p>
- The return value becomes the exit code of the launched process.
- <p>
- If an exception is raised, the policy is:
- <ol>
- <li>Any subset of {@link org.apache.hadoop.util.ExitUtil.ExitException}:
- the exception is passed up unmodified.
- </li>
- <li>Any exception which implements
- {@link org.apache.hadoop.util.ExitCodeProvider}:
- A new {@link ServiceLaunchException} is created with the exit code
- and message of the thrown exception; the thrown exception becomes the
- cause.</li>
- <li>Any other exception: a new {@link ServiceLaunchException} is created
- with the exit code {@link LauncherExitCodes#EXIT_EXCEPTION_THROWN} and
- the message of the original exception (which becomes the cause).</li>
- </ol>
- @return the exit code
- @throws org.apache.hadoop.util.ExitUtil.ExitException an exception passed
- up as the exit code and error text.
- @throws Exception any exception to report. If it provides an exit code
- this is used in a wrapping exception.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An interface which services can implement to have their
- execution managed by the ServiceLauncher.
- <p>
- The command line options will be passed down before the
- {@link Service#init(Configuration)} operation is invoked via an
- invocation of {@link LaunchableService#bindArgs(Configuration, List)}
- After the service has been successfully started via {@link Service#start()}
- the {@link LaunchableService#execute()} method is called to execute the
- service. When this method returns, the service launcher will exit, using
- the return code from the method as its exit option.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.service.launcher.LaunchableService -->
- <!-- start interface org.apache.hadoop.service.launcher.LauncherExitCodes -->
- <interface name="LauncherExitCodes" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="EXIT_SUCCESS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Success: {@value}.]]>
- </doc>
- </field>
- <field name="EXIT_FAIL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Generic "false/fail" response: {@value}.
- The operation worked but the result was not "true" from the viewpoint
- of the executed code.]]>
- </doc>
- </field>
- <field name="EXIT_CLIENT_INITIATED_SHUTDOWN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exit code when a client requested service termination: {@value}.]]>
- </doc>
- </field>
- <field name="EXIT_TASK_LAUNCH_FAILURE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exit code when targets could not be launched: {@value}.]]>
- </doc>
- </field>
- <field name="EXIT_INTERRUPTED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exit code when a control-C, kill -3, signal was picked up: {@value}.]]>
- </doc>
- </field>
- <field name="EXIT_OTHER_FAILURE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exit code when something happened but we can't be specific: {@value}.]]>
- </doc>
- </field>
- <field name="EXIT_COMMAND_ARGUMENT_ERROR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exit code when the command line doesn't parse: {@value}, or
- when it is otherwise invalid.
- <p>
- Approximate HTTP equivalent: {@code 400 Bad Request}]]>
- </doc>
- </field>
- <field name="EXIT_UNAUTHORIZED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The request requires user authentication: {@value}.
- <p>
- approximate HTTP equivalent: Approximate HTTP equivalent: {@code 401 Unauthorized}]]>
- </doc>
- </field>
- <field name="EXIT_USAGE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exit code when a usage message was printed: {@value}.]]>
- </doc>
- </field>
- <field name="EXIT_FORBIDDEN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Forbidden action: {@value}.
- <p>
- Approximate HTTP equivalent: Approximate HTTP equivalent: {@code 403: Forbidden}]]>
- </doc>
- </field>
- <field name="EXIT_NOT_FOUND" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Something was not found: {@value}.
- <p>
- Approximate HTTP equivalent: {@code 404: Not Found}]]>
- </doc>
- </field>
- <field name="EXIT_OPERATION_NOT_ALLOWED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The operation is not allowed: {@value}.
- <p>
- Approximate HTTP equivalent: {@code 405: Not allowed}]]>
- </doc>
- </field>
- <field name="EXIT_NOT_ACCEPTABLE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The command is somehow not acceptable: {@value}.
- <p>
- Approximate HTTP equivalent: {@code 406: Not Acceptable}]]>
- </doc>
- </field>
- <field name="EXIT_CONNECTIVITY_PROBLEM" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exit code on connectivity problems: {@value}.
- <p>
- Approximate HTTP equivalent: {@code 408: Request Timeout}]]>
- </doc>
- </field>
- <field name="EXIT_BAD_CONFIGURATION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exit code when the configurations in valid/incomplete: {@value}.
- <p>
- Approximate HTTP equivalent: {@code 409: Conflict}]]>
- </doc>
- </field>
- <field name="EXIT_EXCEPTION_THROWN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exit code when an exception was thrown from the service: {@value}.
- <p>
- Approximate HTTP equivalent: {@code 500 Internal Server Error}]]>
- </doc>
- </field>
- <field name="EXIT_UNIMPLEMENTED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Unimplemented feature: {@value}.
- <p>
- Approximate HTTP equivalent: {@code 501: Not Implemented}]]>
- </doc>
- </field>
- <field name="EXIT_SERVICE_UNAVAILABLE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Service Unavailable; it may be available later: {@value}.
- <p>
- Approximate HTTP equivalent: {@code 503 Service Unavailable}]]>
- </doc>
- </field>
- <field name="EXIT_UNSUPPORTED_VERSION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The application does not support, or refuses to support this
- version: {@value}.
- <p>
- If raised, this is expected to be raised server-side and likely due
- to client/server version incompatibilities.
- <p>
- Approximate HTTP equivalent: {@code 505: Version Not Supported}]]>
- </doc>
- </field>
- <field name="EXIT_SERVICE_CREATION_FAILURE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The service instance could not be created: {@value}.]]>
- </doc>
- </field>
- <field name="EXIT_SERVICE_LIFECYCLE_EXCEPTION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The service instance could not be created: {@value}.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Common Exit codes.
- <p>
- Codes with a YARN prefix are YARN-related.
- <p>
- Many of the exit codes are designed to resemble HTTP error codes,
- squashed into a single byte. e.g 44 , "not found" is the equivalent
- of 404. The various 2XX HTTP error codes aren't followed;
- the Unix standard of "0" for success is used.
- <pre>
- 0-10: general command issues
- 30-39: equivalent to the 3XX responses, where those responses are
- considered errors by the application.
- 40-49: client-side/CLI/config problems
- 50-59: service-side problems.
- 60+ : application specific error codes
- </pre>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.service.launcher.LauncherExitCodes -->
- <!-- start class org.apache.hadoop.service.launcher.ServiceLaunchException -->
- <class name="ServiceLaunchException" extends="org.apache.hadoop.util.ExitUtil.ExitException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.ExitCodeProvider"/>
- <implements name="org.apache.hadoop.service.launcher.LauncherExitCodes"/>
- <constructor name="ServiceLaunchException" type="int, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an exception with the specific exit code.
- @param exitCode exit code
- @param cause cause of the exception]]>
- </doc>
- </constructor>
- <constructor name="ServiceLaunchException" type="int, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an exception with the specific exit code and text.
- @param exitCode exit code
- @param message message to use in exception]]>
- </doc>
- </constructor>
- <constructor name="ServiceLaunchException" type="int, java.lang.String, java.lang.Object[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a formatted exception.
- <p>
- This uses {@link String#format(String, Object...)}
- to build the formatted exception in the ENGLISH locale.
- <p>
- If the last argument is a throwable, it becomes the cause of the exception.
- It will also be used as a parameter for the format.
- @param exitCode exit code
- @param format format for message to use in exception
- @param args list of arguments]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[A service launch exception that includes an exit code.
- <p>
- When caught by the ServiceLauncher, it will convert that
- into a process exit code.
-
- The {@link #ServiceLaunchException(int, String, Object...)} constructor
- generates formatted exceptions.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.service.launcher.ServiceLaunchException -->
- </package>
- <package name="org.apache.hadoop.tools">
- </package>
- <package name="org.apache.hadoop.tools.protocolPB">
- </package>
- <package name="org.apache.hadoop.tracing">
- <!-- start class org.apache.hadoop.tracing.SpanReceiverInfo -->
- <class name="SpanReceiverInfo" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getId" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getClassName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.tracing.SpanReceiverInfo -->
- <!-- start class org.apache.hadoop.tracing.SpanReceiverInfoBuilder -->
- <class name="SpanReceiverInfoBuilder" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SpanReceiverInfoBuilder" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="addConfigurationPair"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- </method>
- <method name="build" return="org.apache.hadoop.tracing.SpanReceiverInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.tracing.SpanReceiverInfoBuilder -->
- <!-- start interface org.apache.hadoop.tracing.TraceAdminProtocol -->
- <interface name="TraceAdminProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="listSpanReceivers" return="org.apache.hadoop.tracing.SpanReceiverInfo[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List the currently active trace span receivers.
-
- @throws IOException On error.]]>
- </doc>
- </method>
- <method name="addSpanReceiver" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="desc" type="org.apache.hadoop.tracing.SpanReceiverInfo"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add a new trace span receiver.
-
- @param desc The span receiver description.
- @return The ID of the new trace span receiver.
- @throws IOException On error.]]>
- </doc>
- </method>
- <method name="removeSpanReceiver"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="spanReceiverId" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Remove a trace span receiver.
- @param spanReceiverId The id of the span receiver to remove.
- @throws IOException On error.]]>
- </doc>
- </method>
- <field name="versionID" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Protocol interface that provides tracing.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.tracing.TraceAdminProtocol -->
- <!-- start interface org.apache.hadoop.tracing.TraceAdminProtocolPB -->
- <interface name="TraceAdminProtocolPB" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tracing.TraceAdminPB.TraceAdminService.BlockingInterface"/>
- <implements name="org.apache.hadoop.ipc.VersionedProtocol"/>
- </interface>
- <!-- end interface org.apache.hadoop.tracing.TraceAdminProtocolPB -->
- </package>
- <package name="org.apache.hadoop.util">
- <!-- start class org.apache.hadoop.util.ApplicationClassLoader -->
- <class name="ApplicationClassLoader" extends="java.net.URLClassLoader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationClassLoader" type="java.net.URL[], java.lang.ClassLoader, java.util.List"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationClassLoader" type="java.lang.String, java.lang.ClassLoader, java.util.List"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="MalformedURLException" type="java.net.MalformedURLException"/>
- </constructor>
- <method name="getResource" return="java.net.URL"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="loadClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- </method>
- <method name="loadClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="resolve" type="boolean"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- </method>
- <method name="isSystemClass" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="systemClasses" type="java.util.List"/>
- <doc>
- <![CDATA[Checks if a class should be included as a system class.
- A class is a system class if and only if it matches one of the positive
- patterns and none of the negative ones.
- @param name the class name to check
- @param systemClasses a list of system class configurations.
- @return true if the class is a system class]]>
- </doc>
- </method>
- <field name="SYSTEM_CLASSES_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value of the system classes if the user did not override them.
- JDK classes, hadoop classes and resources, and some select third-party
- classes are considered system classes, and are not loaded by the
- application classloader.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A {@link URLClassLoader} for application isolation. Classes from the
- application JARs are loaded in preference to the parent loader.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ApplicationClassLoader -->
- <!-- start interface org.apache.hadoop.util.IPList -->
- <interface name="IPList" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="isIn" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ipAddress" type="java.lang.String"/>
- <doc>
- <![CDATA[returns true if the ipAddress is in the IPList.
- @param ipAddress
- @return boolean value indicating whether the ipAddress is in the IPList]]>
- </doc>
- </method>
- </interface>
- <!-- end interface org.apache.hadoop.util.IPList -->
- <!-- start interface org.apache.hadoop.util.Progressable -->
- <interface name="Progressable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="progress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Report progress to the Hadoop framework.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A facility for reporting progress.
-
- <p>Clients and/or applications can use the provided <code>Progressable</code>
- to explicitly report progress to the Hadoop framework. This is especially
- important for operations which take significant amount of time since,
- in-lieu of the reported progress, the framework has to assume that an error
- has occured and time-out the operation.</p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.util.Progressable -->
- <!-- start class org.apache.hadoop.util.PureJavaCrc32 -->
- <class name="PureJavaCrc32" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.zip.Checksum"/>
- <constructor name="PureJavaCrc32"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new PureJavaCrc32 object.]]>
- </doc>
- </constructor>
- <method name="getValue" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="len" type="int"/>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- </method>
- <doc>
- <![CDATA[A pure-java implementation of the CRC32 checksum that uses
- the same polynomial as the built-in native CRC32.
- This is to avoid the JNI overhead for certain uses of Checksumming
- where many small pieces of data are checksummed in succession.
- The current version is ~10x to 1.8x as fast as Sun's native
- java.util.zip.CRC32 in Java 1.6
- @see java.util.zip.CRC32]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.PureJavaCrc32 -->
- <!-- start class org.apache.hadoop.util.PureJavaCrc32C -->
- <class name="PureJavaCrc32C" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.zip.Checksum"/>
- <constructor name="PureJavaCrc32C"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new PureJavaCrc32 object.]]>
- </doc>
- </constructor>
- <method name="getValue" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- </method>
- <doc>
- <![CDATA[A pure-java implementation of the CRC32 checksum that uses
- the CRC32-C polynomial, the same polynomial used by iSCSI
- and implemented on many Intel chipsets supporting SSE4.2.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.PureJavaCrc32C -->
- <!-- start class org.apache.hadoop.util.ReflectionUtils -->
- <class name="ReflectionUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReflectionUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theObject" type="java.lang.Object"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Check and set 'configuration' if necessary.
-
- @param theObject object for which to set configuration
- @param conf Configuration]]>
- </doc>
- </method>
- <method name="newInstance" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Create an object for the given class and initialize it from conf
-
- @param theClass class of which an object is created
- @param conf Configuration
- @return a new object]]>
- </doc>
- </method>
- <method name="setContentionTracing"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="boolean"/>
- </method>
- <method name="printThreadInfo"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.PrintStream"/>
- <param name="title" type="java.lang.String"/>
- <doc>
- <![CDATA[Print all of the thread's information and stack traces.
-
- @param stream the stream to
- @param title a string title for the stack trace]]>
- </doc>
- </method>
- <method name="logThreadInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="log" type="org.apache.commons.logging.Log"/>
- <param name="title" type="java.lang.String"/>
- <param name="minInterval" type="long"/>
- <doc>
- <![CDATA[Log the current thread stacks at INFO level.
- @param log the logger that logs the stack trace
- @param title a descriptive title for the call stacks
- @param minInterval the minimum time from the last]]>
- </doc>
- </method>
- <method name="logThreadInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="log" type="org.slf4j.Logger"/>
- <param name="title" type="java.lang.String"/>
- <param name="minInterval" type="long"/>
- <doc>
- <![CDATA[Log the current thread stacks at INFO level.
- @param log the logger that logs the stack trace
- @param title a descriptive title for the call stacks
- @param minInterval the minimum time from the last]]>
- </doc>
- </method>
- <method name="getClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="T"/>
- <doc>
- <![CDATA[Return the correctly-typed {@link Class} of the given object.
-
- @param o object whose correctly-typed <code>Class</code> is to be obtained
- @return the correctly typed <code>Class</code> of the given object.]]>
- </doc>
- </method>
- <method name="copy" return="T"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="src" type="T"/>
- <param name="dst" type="T"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make a copy of the writable object using serialization to a buffer
- @param src the object to copy from
- @param dst the object to copy into, which is destroyed
- @return dst param (the copy)
- @throws IOException]]>
- </doc>
- </method>
- <method name="cloneWritableInto"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dst" type="org.apache.hadoop.io.Writable"/>
- <param name="src" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getDeclaredFieldsIncludingInherited" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="clazz" type="java.lang.Class"/>
- <doc>
- <![CDATA[Gets all the declared fields of a class including fields declared in
- superclasses.]]>
- </doc>
- </method>
- <method name="getDeclaredMethodsIncludingInherited" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="clazz" type="java.lang.Class"/>
- <doc>
- <![CDATA[Gets all the declared methods of a class including methods declared in
- superclasses.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[General reflection utils]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ReflectionUtils -->
- <!-- start class org.apache.hadoop.util.Shell -->
- <class name="Shell" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Shell"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an instance with no minimum interval between runs; stderr is
- not merged with stdout.]]>
- </doc>
- </constructor>
- <constructor name="Shell" type="long"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an instance with a minimum interval between executions; stderr is
- not merged with stdout.
- @param interval interval in milliseconds between command executions.]]>
- </doc>
- </constructor>
- <constructor name="Shell" type="long, boolean"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a shell instance which can be re-executed when the {@link #run()}
- method is invoked with a given elapsed time between calls.
- @param interval the minimum duration in milliseconds to wait before
- re-executing the command. If set to 0, there is no minimum.
- @param redirectErrorStream should the error stream be merged with
- the normal output stream?]]>
- </doc>
- </constructor>
- <method name="isJava7OrAbove" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="This call isn't needed any more: please remove uses of it.">
- <doc>
- <![CDATA[query to see if system is Java 7 or later.
- Now that Hadoop requires Java 7 or later, this always returns true.
- @deprecated This call isn't needed any more: please remove uses of it.
- @return true, always.]]>
- </doc>
- </method>
- <method name="checkWindowsCommandLineLength"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="commands" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Checks if a given command (String[]) fits in the Windows maximum command
- line length Note that the input is expected to already include space
- delimiters, no extra count will be added for delimiters.
- @param commands command parts, including any space delimiters]]>
- </doc>
- </method>
- <method name="getGroupsCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to get the current user's groups list.]]>
- </doc>
- </method>
- <method name="getGroupsForUserCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <doc>
- <![CDATA[A command to get a given user's groups list.
- If the OS is not WINDOWS, the command will get the user's primary group
- first and finally get the groups list which includes the primary group.
- i.e. the user's primary group will be included twice.]]>
- </doc>
- </method>
- <method name="getGroupsIDForUserCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <doc>
- <![CDATA[A command to get a given user's group id list.
- The command will get the user's primary group
- first and finally get the groups list which includes the primary group.
- i.e. the user's primary group will be included twice.
- This command does not support Windows and will only return group names.]]>
- </doc>
- </method>
- <method name="getUsersForNetgroupCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="netgroup" type="java.lang.String"/>
- <doc>
- <![CDATA[A command to get a given netgroup's user list.]]>
- </doc>
- </method>
- <method name="getGetPermissionCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a command to get permission information.]]>
- </doc>
- </method>
- <method name="getSetPermissionCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="perm" type="java.lang.String"/>
- <param name="recursive" type="boolean"/>
- <doc>
- <![CDATA[Return a command to set permission.]]>
- </doc>
- </method>
- <method name="getSetPermissionCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="perm" type="java.lang.String"/>
- <param name="recursive" type="boolean"/>
- <param name="file" type="java.lang.String"/>
- <doc>
- <![CDATA[Return a command to set permission for specific file.
- @param perm String permission to set
- @param recursive boolean true to apply to all sub-directories recursively
- @param file String file to set
- @return String[] containing command and arguments]]>
- </doc>
- </method>
- <method name="getSetOwnerCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="owner" type="java.lang.String"/>
- <doc>
- <![CDATA[Return a command to set owner.]]>
- </doc>
- </method>
- <method name="getSymlinkCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="java.lang.String"/>
- <param name="link" type="java.lang.String"/>
- <doc>
- <![CDATA[Return a command to create symbolic links.]]>
- </doc>
- </method>
- <method name="getReadlinkCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="link" type="java.lang.String"/>
- <doc>
- <![CDATA[Return a command to read the target of the a symbolic link.]]>
- </doc>
- </method>
- <method name="getCheckProcessIsAliveCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pid" type="java.lang.String"/>
- <doc>
- <![CDATA[Return a command for determining if process with specified pid is alive.
- @param pid process ID
- @return a <code>kill -0</code> command or equivalent]]>
- </doc>
- </method>
- <method name="getSignalKillCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="code" type="int"/>
- <param name="pid" type="java.lang.String"/>
- <doc>
- <![CDATA[Return a command to send a signal to a given pid.]]>
- </doc>
- </method>
- <method name="getEnvironmentVariableRegex" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a regular expression string that match environment variables.]]>
- </doc>
- </method>
- <method name="appendScriptExtension" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="parent" type="java.io.File"/>
- <param name="basename" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns a File referencing a script with the given basename, inside the
- given parent directory. The file extension is inferred by platform:
- <code>".cmd"</code> on Windows, or <code>".sh"</code> otherwise.
- @param parent File parent directory
- @param basename String script file basename
- @return File referencing the script in the directory]]>
- </doc>
- </method>
- <method name="appendScriptExtension" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="basename" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns a script file name with the given basename.
- The file extension is inferred by platform:
- <code>".cmd"</code> on Windows, or <code>".sh"</code> otherwise.
- @param basename String script file basename
- @return String script file name]]>
- </doc>
- </method>
- <method name="getRunScriptCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="script" type="java.io.File"/>
- <doc>
- <![CDATA[Returns a command to run the given script. The script interpreter is
- inferred by platform: cmd on Windows or bash otherwise.
- @param script File script to run
- @return String[] command to run the script]]>
- </doc>
- </method>
- <method name="getHadoopHome" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the Hadoop home directory. Raises an exception if not found
- @return the home dir
- @throws IOException if the home directory cannot be located.]]>
- </doc>
- </method>
- <method name="getQualifiedBin" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="executable" type="java.lang.String"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <doc>
- <![CDATA[Fully qualify the path to a binary that should be in a known hadoop
- bin location. This is primarily useful for disambiguating call-outs
- to executable sub-components of Hadoop to avoid clashes with other
- executables that may be in the path. Caveat: this call doesn't
- just format the path to the bin directory. It also checks for file
- existence of the composed path. The output of this call should be
- cached by callers.
- @param executable executable
- @return executable file reference
- @throws FileNotFoundException if the path does not exist]]>
- </doc>
- </method>
- <method name="getQualifiedBinPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="executable" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fully qualify the path to a binary that should be in a known hadoop
- bin location. This is primarily useful for disambiguating call-outs
- to executable sub-components of Hadoop to avoid clashes with other
- executables that may be in the path. Caveat: this call doesn't
- just format the path to the bin directory. It also checks for file
- existence of the composed path. The output of this call should be
- cached by callers.
- @param executable executable
- @return executable file reference
- @throws FileNotFoundException if the path does not exist
- @throws IOException on path canonicalization failures]]>
- </doc>
- </method>
- <method name="hasWinutilsPath" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Predicate to indicate whether or not the path to winutils is known.
- If true, then {@link #WINUTILS} is non-null, and both
- {@link #getWinUtilsPath()} and {@link #getWinUtilsFile()}
- will successfully return this value. Always false on non-windows systems.
- @return true if there is a valid path to the binary]]>
- </doc>
- </method>
- <method name="getWinUtilsPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Locate the winutils binary, or fail with a meaningful
- exception and stack trace as an RTE.
- This method is for use in methods which don't explicitly throw
- an <code>IOException</code>.
- @return the path to {@link #WINUTILS_EXE}
- @throws RuntimeException if the path is not resolvable]]>
- </doc>
- </method>
- <method name="getWinUtilsFile" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <doc>
- <![CDATA[Get a file reference to winutils.
- Always raises an exception if there isn't one
- @return the file instance referring to the winutils bin.
- @throws FileNotFoundException on any failure to locate that file.]]>
- </doc>
- </method>
- <method name="checkIsBashSupported" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="InterruptedIOException" type="java.io.InterruptedIOException"/>
- </method>
- <method name="setEnvironment"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="env" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the environment for the command.
- @param env Mapping of environment variables]]>
- </doc>
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <doc>
- <![CDATA[Set the working directory.
- @param dir The directory where the command will be executed]]>
- </doc>
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check to see if a command needs to be executed and execute if needed.]]>
- </doc>
- </method>
- <method name="getExecString" return="java.lang.String[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[return an array containing the command name and its parameters.]]>
- </doc>
- </method>
- <method name="parseExecResult"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="lines" type="java.io.BufferedReader"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Parse the execution result]]>
- </doc>
- </method>
- <method name="getEnvironment" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="env" type="java.lang.String"/>
- <doc>
- <![CDATA[Get an environment variable.
- @param env the environment var
- @return the value or null if it was unset.]]>
- </doc>
- </method>
- <method name="getProcess" return="java.lang.Process"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the current sub-process executing the given command.
- @return process executing the command]]>
- </doc>
- </method>
- <method name="getExitCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the exit code.
- @return the exit code of the process]]>
- </doc>
- </method>
- <method name="getWaitingThread" return="java.lang.Thread"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the thread that is waiting on this instance of <code>Shell</code>.
- @return the thread that ran runCommand() that spawned this shell
- or null if no thread is waiting for this shell to complete]]>
- </doc>
- </method>
- <method name="isTimedOut" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[To check if the passed script to shell command executor timed out or
- not.
- @return if the script timed out.]]>
- </doc>
- </method>
- <method name="execCommand" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cmd" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Static method to execute a shell command.
- Covers most of the simple cases without requiring the user to implement
- the <code>Shell</code> interface.
- @param cmd shell command to execute.
- @return the output of the executed command.]]>
- </doc>
- </method>
- <method name="execCommand" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="env" type="java.util.Map"/>
- <param name="cmd" type="java.lang.String[]"/>
- <param name="timeout" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Static method to execute a shell command.
- Covers most of the simple cases without requiring the user to implement
- the <code>Shell</code> interface.
- @param env the map of environment key=value
- @param cmd shell command to execute.
- @param timeout time in milliseconds after which script should be marked timeout
- @return the output of the executed command.
- @throws IOException on any problem.]]>
- </doc>
- </method>
- <method name="execCommand" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="env" type="java.util.Map"/>
- <param name="cmd" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Static method to execute a shell command.
- Covers most of the simple cases without requiring the user to implement
- the <code>Shell</code> interface.
- @param env the map of environment key=value
- @param cmd shell command to execute.
- @return the output of the executed command.
- @throws IOException on any problem.]]>
- </doc>
- </method>
- <method name="destroyAllShellProcesses"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Static method to destroy all running <code>Shell</code> processes.
- Iterates through a map of all currently running <code>Shell</code>
- processes and destroys them one by one. This method is thread safe]]>
- </doc>
- </method>
- <method name="getAllShells" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Static method to return a Set of all <code>Shell</code> objects.]]>
- </doc>
- </method>
- <method name="getMemlockLimit" return="java.lang.Long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ulimit" type="java.lang.Long"/>
- <doc>
- <![CDATA[Static method to return the memory lock limit for datanode.
- @param ulimit max value at which memory locked should be capped.
- @return long value specifying the memory lock limit.]]>
- </doc>
- </method>
- <field name="LOG" type="org.slf4j.Logger"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SYSPROP_HADOOP_HOME_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[System property for the Hadoop home directory: {@value}.]]>
- </doc>
- </field>
- <field name="ENV_HADOOP_HOME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Environment variable for Hadoop's home dir: {@value}.]]>
- </doc>
- </field>
- <field name="WINDOWS_MAX_SHELL_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Maximum command line length in Windows
- KB830473 documents this as 8191]]>
- </doc>
- </field>
- <field name="WINDOWS_MAX_SHELL_LENGHT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="use the correctly spelled constant.">
- <doc>
- <![CDATA[mis-spelling of {@link #WINDOWS_MAX_SHELL_LENGTH}.
- @deprecated use the correctly spelled constant.]]>
- </doc>
- </field>
- <field name="USER_NAME_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to get the current user's name: {@value}.]]>
- </doc>
- </field>
- <field name="WindowsProcessLaunchLock" type="java.lang.Object"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Windows <code>CreateProcess</code> synchronization object.]]>
- </doc>
- </field>
- <field name="osType" type="org.apache.hadoop.util.Shell.OSType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type of the operating system, as determined from parsing
- the <code>os.name</code> property.]]>
- </doc>
- </field>
- <field name="WINDOWS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SOLARIS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAC" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FREEBSD" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LINUX" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="OTHER" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PPC_64" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENV_NAME_REGEX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Regular expression for environment variables: {@value}.]]>
- </doc>
- </field>
- <field name="SET_PERMISSION_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to set permission: {@value}.]]>
- </doc>
- </field>
- <field name="SET_OWNER_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to set owner: {@value}.]]>
- </doc>
- </field>
- <field name="SET_GROUP_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to set the change user's groups list: {@value}.]]>
- </doc>
- </field>
- <field name="LINK_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to create a link: {@value}.]]>
- </doc>
- </field>
- <field name="READ_LINK_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to get a link target: {@value}.]]>
- </doc>
- </field>
- <field name="timeOutInterval" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Time after which the executing script would be timedout.]]>
- </doc>
- </field>
- <field name="inheritParentEnv" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Indicates if the parent env vars should be inherited or not]]>
- </doc>
- </field>
- <field name="WINUTILS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="use one of the exception-raising getter methods,
- specifically {@link #getWinUtilsPath()} or {@link #getWinUtilsFile()}">
- <doc>
- <![CDATA[Location of winutils as a string; null if not found.
- <p>
- <i>Important: caller must check for this value being null</i>.
- The lack of such checks has led to many support issues being raised.
- <p>
- @deprecated use one of the exception-raising getter methods,
- specifically {@link #getWinUtilsPath()} or {@link #getWinUtilsFile()}]]>
- </doc>
- </field>
- <field name="isSetsidAvailable" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Flag which is true if setsid exists.]]>
- </doc>
- </field>
- <field name="TOKEN_SEPARATOR_REGEX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Token separator regex used to parse Shell tool outputs.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A base class for running a Shell command.
- <code>Shell</code> can be used to run shell commands like <code>du</code> or
- <code>df</code>. It also offers facilities to gate commands by
- time-intervals.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.Shell -->
- <!-- start class org.apache.hadoop.util.ShutdownHookManager -->
- <class name="ShutdownHookManager" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="get" return="org.apache.hadoop.util.ShutdownHookManager"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return <code>ShutdownHookManager</code> singleton.
- @return <code>ShutdownHookManager</code> singleton.]]>
- </doc>
- </method>
- <method name="addShutdownHook"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="shutdownHook" type="java.lang.Runnable"/>
- <param name="priority" type="int"/>
- <doc>
- <![CDATA[Adds a shutdownHook with a priority, the higher the priority
- the earlier will run. ShutdownHooks with same priority run
- in a non-deterministic order.
- @param shutdownHook shutdownHook <code>Runnable</code>
- @param priority priority of the shutdownHook.]]>
- </doc>
- </method>
- <method name="addShutdownHook"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="shutdownHook" type="java.lang.Runnable"/>
- <param name="priority" type="int"/>
- <param name="timeout" type="long"/>
- <param name="unit" type="java.util.concurrent.TimeUnit"/>
- <doc>
- <![CDATA[Adds a shutdownHook with a priority and timeout the higher the priority
- the earlier will run. ShutdownHooks with same priority run
- in a non-deterministic order. The shutdown hook will be terminated if it
- has not been finished in the specified period of time.
- @param shutdownHook shutdownHook <code>Runnable</code>
- @param priority priority of the shutdownHook
- @param timeout timeout of the shutdownHook
- @param unit unit of the timeout <code>TimeUnit</code>]]>
- </doc>
- </method>
- <method name="removeShutdownHook" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="shutdownHook" type="java.lang.Runnable"/>
- <doc>
- <![CDATA[Removes a shutdownHook.
- @param shutdownHook shutdownHook to remove.
- @return TRUE if the shutdownHook was registered and removed,
- FALSE otherwise.]]>
- </doc>
- </method>
- <method name="hasShutdownHook" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="shutdownHook" type="java.lang.Runnable"/>
- <doc>
- <![CDATA[Indicates if a shutdownHook is registered or not.
- @param shutdownHook shutdownHook to check if registered.
- @return TRUE/FALSE depending if the shutdownHook is is registered.]]>
- </doc>
- </method>
- <method name="isShutdownInProgress" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Indicates if shutdown is in progress or not.
-
- @return TRUE if the shutdown is in progress, otherwise FALSE.]]>
- </doc>
- </method>
- <method name="clearShutdownHooks"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[clear all registered shutdownHooks.]]>
- </doc>
- </method>
- <field name="TIMEOUT_MINIMUM" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Minimum shutdown timeout: {@value} second(s).]]>
- </doc>
- </field>
- <field name="TIME_UNIT_DEFAULT" type="java.util.concurrent.TimeUnit"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default time unit used: seconds.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The <code>ShutdownHookManager</code> enables running shutdownHook
- in a deterministic order, higher priority first.
- <p/>
- The JVM runs ShutdownHooks in a non-deterministic order or in parallel.
- This class registers a single JVM shutdownHook and run all the
- shutdownHooks registered to it (to this class) in order based on their
- priority.
- Unless a hook was registered with a shutdown explicitly set through
- {@link #addShutdownHook(Runnable, int, long, TimeUnit)},
- the shutdown time allocated to it is set by the configuration option
- {@link CommonConfigurationKeysPublic#SERVICE_SHUTDOWN_TIMEOUT} in
- {@code core-site.xml}, with a default value of
- {@link CommonConfigurationKeysPublic#SERVICE_SHUTDOWN_TIMEOUT_DEFAULT}
- seconds.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ShutdownHookManager -->
- <!-- start class org.apache.hadoop.util.StringInterner -->
- <class name="StringInterner" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StringInterner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="strongIntern" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sample" type="java.lang.String"/>
- <doc>
- <![CDATA[Interns and returns a reference to the representative instance
- for any of a collection of string instances that are equal to each other.
- Retains strong reference to the instance,
- thus preventing it from being garbage-collected.
-
- @param sample string instance to be interned
- @return strong reference to interned string instance]]>
- </doc>
- </method>
- <method name="weakIntern" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sample" type="java.lang.String"/>
- <doc>
- <![CDATA[Interns and returns a reference to the representative instance
- for any of a collection of string instances that are equal to each other.
- Retains weak reference to the instance,
- and so does not prevent it from being garbage-collected.
-
- @param sample string instance to be interned
- @return weak reference to interned string instance]]>
- </doc>
- </method>
- <method name="internStringsInArray" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="strings" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Interns all the strings in the given array in place,
- returning the same array.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Provides string interning utility methods. For weak interning,
- we use the standard String.intern() call, that performs very well
- (no problems with PermGen overflowing, etc.) starting from JDK 7.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.StringInterner -->
- <!-- start class org.apache.hadoop.util.SysInfo -->
- <class name="SysInfo" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SysInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.util.SysInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return default OS instance.
- @throws UnsupportedOperationException If cannot determine OS.
- @return Default instance for the detected OS.]]>
- </doc>
- </method>
- <method name="getVirtualMemorySize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total size of the virtual memory present in the system.
- @return virtual memory size in bytes.]]>
- </doc>
- </method>
- <method name="getPhysicalMemorySize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total size of the physical memory present in the system.
- @return physical memory size bytes.]]>
- </doc>
- </method>
- <method name="getAvailableVirtualMemorySize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total size of the available virtual memory present
- in the system.
- @return available virtual memory size in bytes.]]>
- </doc>
- </method>
- <method name="getAvailablePhysicalMemorySize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total size of the available physical memory present
- in the system.
- @return available physical memory size bytes.]]>
- </doc>
- </method>
- <method name="getNumProcessors" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total number of logical processors present on the system.
- @return number of logical processors]]>
- </doc>
- </method>
- <method name="getNumCores" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain total number of physical cores present on the system.
- @return number of physical cores]]>
- </doc>
- </method>
- <method name="getCpuFrequency" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the CPU frequency of on the system.
- @return CPU frequency in kHz]]>
- </doc>
- </method>
- <method name="getCumulativeCpuTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the cumulative CPU time since the system is on.
- @return cumulative CPU time in milliseconds]]>
- </doc>
- </method>
- <method name="getCpuUsagePercentage" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the CPU usage % of the machine. Return -1 if it is unavailable
- @return CPU usage as a percentage (from 0 to 100) of available cycles.]]>
- </doc>
- </method>
- <method name="getNumVCoresUsed" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the number of VCores used. Return -1 if it is unavailable
- @return Number of VCores used a percentage (from 0 to #VCores).]]>
- </doc>
- </method>
- <method name="getNetworkBytesRead" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the aggregated number of bytes read over the network.
- @return total number of bytes read.]]>
- </doc>
- </method>
- <method name="getNetworkBytesWritten" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the aggregated number of bytes written to the network.
- @return total number of bytes written.]]>
- </doc>
- </method>
- <method name="getStorageBytesRead" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the aggregated number of bytes read from disks.
- @return total number of bytes read.]]>
- </doc>
- </method>
- <method name="getStorageBytesWritten" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the aggregated number of bytes written to disks.
- @return total number of bytes written.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Plugin to calculate resource information on the system.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.SysInfo -->
- <!-- start interface org.apache.hadoop.util.Tool -->
- <interface name="Tool" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Execute the command with the given arguments.
-
- @param args command specific arguments.
- @return exit code.
- @throws Exception]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A tool interface that supports handling of generic command-line options.
-
- <p><code>Tool</code>, is the standard for any Map-Reduce tool/application.
- The tool/application should delegate the handling of
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/CommandsManual.html#Generic_Options">
- standard command-line options</a> to {@link ToolRunner#run(Tool, String[])}
- and only handle its custom arguments.</p>
-
- <p>Here is how a typical <code>Tool</code> is implemented:</p>
- <p><blockquote><pre>
- public class MyApp extends Configured implements Tool {
-
- public int run(String[] args) throws Exception {
- // <code>Configuration</code> processed by <code>ToolRunner</code>
- Configuration conf = getConf();
-
- // Create a JobConf using the processed <code>conf</code>
- JobConf job = new JobConf(conf, MyApp.class);
-
- // Process custom command-line options
- Path in = new Path(args[1]);
- Path out = new Path(args[2]);
-
- // Specify various job-specific parameters
- job.setJobName("my-app");
- job.setInputPath(in);
- job.setOutputPath(out);
- job.setMapperClass(MyMapper.class);
- job.setReducerClass(MyReducer.class);
- // Submit the job, then poll for progress until the job is complete
- RunningJob runningJob = JobClient.runJob(job);
- if (runningJob.isSuccessful()) {
- return 0;
- } else {
- return 1;
- }
- }
-
- public static void main(String[] args) throws Exception {
- // Let <code>ToolRunner</code> handle generic command-line options
- int res = ToolRunner.run(new Configuration(), new MyApp(), args);
-
- System.exit(res);
- }
- }
- </pre></blockquote></p>
-
- @see GenericOptionsParser
- @see ToolRunner]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.util.Tool -->
- <!-- start class org.apache.hadoop.util.ToolRunner -->
- <class name="ToolRunner" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ToolRunner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="tool" type="org.apache.hadoop.util.Tool"/>
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Runs the given <code>Tool</code> by {@link Tool#run(String[])}, after
- parsing with the given generic arguments. Uses the given
- <code>Configuration</code>, or builds one if null.
-
- Sets the <code>Tool</code>'s configuration with the possibly modified
- version of the <code>conf</code>.
-
- @param conf <code>Configuration</code> for the <code>Tool</code>.
- @param tool <code>Tool</code> to run.
- @param args command-line arguments to the tool.
- @return exit code of the {@link Tool#run(String[])} method.]]>
- </doc>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tool" type="org.apache.hadoop.util.Tool"/>
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Runs the <code>Tool</code> with its <code>Configuration</code>.
-
- Equivalent to <code>run(tool.getConf(), tool, args)</code>.
-
- @param tool <code>Tool</code> to run.
- @param args command-line arguments to the tool.
- @return exit code of the {@link Tool#run(String[])} method.]]>
- </doc>
- </method>
- <method name="printGenericCommandUsage"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.PrintStream"/>
- <doc>
- <![CDATA[Prints generic command-line argurments and usage information.
-
- @param out stream to write usage information to.]]>
- </doc>
- </method>
- <method name="confirmPrompt" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="prompt" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Print out a prompt to the user, and return true if the user
- responds with "y" or "yes". (case insensitive)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A utility to help run {@link Tool}s.
-
- <p><code>ToolRunner</code> can be used to run classes implementing
- <code>Tool</code> interface. It works in conjunction with
- {@link GenericOptionsParser} to parse the
- <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/CommandsManual.html#Generic_Options">
- generic hadoop command line arguments</a> and modifies the
- <code>Configuration</code> of the <code>Tool</code>. The
- application-specific options are passed along without being modified.
- </p>
-
- @see Tool
- @see GenericOptionsParser]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ToolRunner -->
- <!-- start class org.apache.hadoop.util.VersionInfo -->
- <class name="VersionInfo" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="VersionInfo" type="java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="_getVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="_getRevision" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="_getBranch" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="_getDate" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="_getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="_getUrl" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="_getSrcChecksum" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="_getBuildVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="_getProtocVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Hadoop version.
- @return the Hadoop version string, eg. "0.6.3-dev"]]>
- </doc>
- </method>
- <method name="getRevision" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Git commit hash of the repository when compiled.
- @return the commit hash, eg. "18f64065d5db6208daf50b02c1b5ed4ee3ce547a"]]>
- </doc>
- </method>
- <method name="getBranch" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the branch on which this originated.
- @return The branch name, e.g. "trunk" or "branches/branch-0.20"]]>
- </doc>
- </method>
- <method name="getDate" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The date that Hadoop was compiled.
- @return the compilation date in unix date format]]>
- </doc>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The user that compiled Hadoop.
- @return the username of the user]]>
- </doc>
- </method>
- <method name="getUrl" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the URL for the Hadoop repository.
- @return the URL of the Hadoop repository]]>
- </doc>
- </method>
- <method name="getSrcChecksum" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the checksum of the source files from which Hadoop was built.
- @return the checksum of the source files]]>
- </doc>
- </method>
- <method name="getBuildVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the buildVersion which includes version,
- revision, user and date.
- @return the buildVersion]]>
- </doc>
- </method>
- <method name="getProtocVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the protoc version used for the build.
- @return the protoc version]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- </method>
- <doc>
- <![CDATA[This class returns build information about Hadoop components.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.VersionInfo -->
- <doc>
- <![CDATA[Common utilities.]]>
- </doc>
- </package>
- <package name="org.apache.hadoop.util.bloom">
- <!-- start class org.apache.hadoop.util.bloom.BloomFilter -->
- <class name="BloomFilter" extends="org.apache.hadoop.util.bloom.Filter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BloomFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor - use with readFields]]>
- </doc>
- </constructor>
- <constructor name="BloomFilter" type="int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
- @param vectorSize The vector size of <i>this</i> filter.
- @param nbHash The number of hash function to consider.
- @param hashType type of the hashing function (see
- {@link org.apache.hadoop.util.hash.Hash}).]]>
- </doc>
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="and"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="membershipTest" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="not"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="or"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="xor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getVectorSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return size of the the bloomfilter]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implements a <i>Bloom filter</i>, as defined by Bloom in 1970.
- <p>
- The Bloom filter is a data structure that was introduced in 1970 and that has been adopted by
- the networking research community in the past decade thanks to the bandwidth efficiencies that it
- offers for the transmission of set membership information between networked hosts. A sender encodes
- the information into a bit vector, the Bloom filter, that is more compact than a conventional
- representation. Computation and space costs for construction are linear in the number of elements.
- The receiver uses the filter to test whether various elements are members of the set. Though the
- filter will occasionally return a false positive, it will never return a false negative. When creating
- the filter, the sender can choose its desired point in a trade-off between the false positive rate and the size.
-
- <p>
- Originally created by
- <a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
-
- @see Filter The general behavior of a filter
-
- @see <a href="http://portal.acm.org/citation.cfm?id=362692&dl=ACM&coll=portal">Space/Time Trade-Offs in Hash Coding with Allowable Errors</a>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.BloomFilter -->
- <!-- start class org.apache.hadoop.util.bloom.CountingBloomFilter -->
- <class name="CountingBloomFilter" extends="org.apache.hadoop.util.bloom.Filter"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="CountingBloomFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor - use with readFields]]>
- </doc>
- </constructor>
- <constructor name="CountingBloomFilter" type="int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
- @param vectorSize The vector size of <i>this</i> filter.
- @param nbHash The number of hash function to consider.
- @param hashType type of the hashing function (see
- {@link org.apache.hadoop.util.hash.Hash}).]]>
- </doc>
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="delete"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- <doc>
- <![CDATA[Removes a specified key from <i>this</i> counting Bloom filter.
- <p>
- <b>Invariant</b>: nothing happens if the specified key does not belong to <i>this</i> counter Bloom filter.
- @param key The key to remove.]]>
- </doc>
- </method>
- <method name="and"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="membershipTest" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="approximateCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- <doc>
- <![CDATA[This method calculates an approximate count of the key, i.e. how many
- times the key was added to the filter. This allows the filter to be
- used as an approximate <code>key -> count</code> map.
- <p>NOTE: due to the bucket size of this filter, inserting the same
- key more than 15 times will cause an overflow at all filter positions
- associated with this key, and it will significantly increase the error
- rate for this and other keys. For this reason the filter can only be
- used to store small count values <code>0 <= N << 15</code>.
- @param key key to be tested
- @return 0 if the key is not present. Otherwise, a positive value v will
- be returned such that <code>v == count</code> with probability equal to the
- error rate of this filter, and <code>v > count</code> otherwise.
- Additionally, if the filter experienced an underflow as a result of
- {@link #delete(Key)} operation, the return value may be lower than the
- <code>count</code> with the probability of the false negative rate of such
- filter.]]>
- </doc>
- </method>
- <method name="not"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="or"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="xor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implements a <i>counting Bloom filter</i>, as defined by Fan et al. in a ToN
- 2000 paper.
- <p>
- A counting Bloom filter is an improvement to standard a Bloom filter as it
- allows dynamic additions and deletions of set membership information. This
- is achieved through the use of a counting vector instead of a bit vector.
- <p>
- Originally created by
- <a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
- @see Filter The general behavior of a filter
-
- @see <a href="http://portal.acm.org/citation.cfm?id=343571.343572">Summary cache: a scalable wide-area web cache sharing protocol</a>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.CountingBloomFilter -->
- <!-- start class org.apache.hadoop.util.bloom.DynamicBloomFilter -->
- <class name="DynamicBloomFilter" extends="org.apache.hadoop.util.bloom.Filter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DynamicBloomFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Zero-args constructor for the serialization.]]>
- </doc>
- </constructor>
- <constructor name="DynamicBloomFilter" type="int, int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
- <p>
- Builds an empty Dynamic Bloom filter.
- @param vectorSize The number of bits in the vector.
- @param nbHash The number of hash function to consider.
- @param hashType type of the hashing function (see
- {@link org.apache.hadoop.util.hash.Hash}).
- @param nr The threshold for the maximum number of keys to record in a
- dynamic Bloom filter row.]]>
- </doc>
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="and"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="membershipTest" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="not"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="or"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="xor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implements a <i>dynamic Bloom filter</i>, as defined in the INFOCOM 2006 paper.
- <p>
- A dynamic Bloom filter (DBF) makes use of a <code>s * m</code> bit matrix but
- each of the <code>s</code> rows is a standard Bloom filter. The creation
- process of a DBF is iterative. At the start, the DBF is a <code>1 * m</code>
- bit matrix, i.e., it is composed of a single standard Bloom filter.
- It assumes that <code>n<sub>r</sub></code> elements are recorded in the
- initial bit vector, where <code>n<sub>r</sub> <= n</code> (<code>n</code> is
- the cardinality of the set <code>A</code> to record in the filter).
- <p>
- As the size of <code>A</code> grows during the execution of the application,
- several keys must be inserted in the DBF. When inserting a key into the DBF,
- one must first get an active Bloom filter in the matrix. A Bloom filter is
- active when the number of recorded keys, <code>n<sub>r</sub></code>, is
- strictly less than the current cardinality of <code>A</code>, <code>n</code>.
- If an active Bloom filter is found, the key is inserted and
- <code>n<sub>r</sub></code> is incremented by one. On the other hand, if there
- is no active Bloom filter, a new one is created (i.e., a new row is added to
- the matrix) according to the current size of <code>A</code> and the element
- is added in this new Bloom filter and the <code>n<sub>r</sub></code> value of
- this new Bloom filter is set to one. A given key is said to belong to the
- DBF if the <code>k</code> positions are set to one in one of the matrix rows.
- <p>
- Originally created by
- <a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
- @see Filter The general behavior of a filter
- @see BloomFilter A Bloom filter
-
- @see <a href="http://www.cse.fau.edu/~jie/research/publications/Publication_files/infocom2006.pdf">Theory and Network Applications of Dynamic Bloom Filters</a>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.DynamicBloomFilter -->
- <!-- start class org.apache.hadoop.util.bloom.HashFunction -->
- <class name="HashFunction" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="HashFunction" type="int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
- <p>
- Builds a hash function that must obey to a given maximum number of returned values and a highest value.
- @param maxValue The maximum highest returned value.
- @param nbHash The number of resulting hashed values.
- @param hashType type of the hashing function (see {@link Hash}).]]>
- </doc>
- </constructor>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clears <i>this</i> hash function. A NOOP]]>
- </doc>
- </method>
- <method name="hash" return="int[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="k" type="org.apache.hadoop.util.bloom.Key"/>
- <doc>
- <![CDATA[Hashes a specified key into several integers.
- @param k The specified key.
- @return The array of hashed values.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implements a hash object that returns a certain number of hashed values.
-
- @see Key The general behavior of a key being stored in a filter
- @see Filter The general behavior of a filter]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.HashFunction -->
- <!-- start interface org.apache.hadoop.util.bloom.RemoveScheme -->
- <interface name="RemoveScheme" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="RANDOM" type="short"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Random selection.
- <p>
- The idea is to randomly select a bit to reset.]]>
- </doc>
- </field>
- <field name="MINIMUM_FN" type="short"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[MinimumFN Selection.
- <p>
- The idea is to select the bit to reset that will generate the minimum
- number of false negative.]]>
- </doc>
- </field>
- <field name="MAXIMUM_FP" type="short"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[MaximumFP Selection.
- <p>
- The idea is to select the bit to reset that will remove the maximum number
- of false positive.]]>
- </doc>
- </field>
- <field name="RATIO" type="short"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Ratio Selection.
- <p>
- The idea is to select the bit to reset that will, at the same time, remove
- the maximum number of false positve while minimizing the amount of false
- negative generated.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Defines the different remove scheme for retouched Bloom filters.
- <p>
- Originally created by
- <a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.util.bloom.RemoveScheme -->
- <!-- start class org.apache.hadoop.util.bloom.RetouchedBloomFilter -->
- <class name="RetouchedBloomFilter" extends="org.apache.hadoop.util.bloom.BloomFilter"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.bloom.RemoveScheme"/>
- <constructor name="RetouchedBloomFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor - use with readFields]]>
- </doc>
- </constructor>
- <constructor name="RetouchedBloomFilter" type="int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
- @param vectorSize The vector size of <i>this</i> filter.
- @param nbHash The number of hash function to consider.
- @param hashType type of the hashing function (see
- {@link org.apache.hadoop.util.hash.Hash}).]]>
- </doc>
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="addFalsePositive"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- <doc>
- <![CDATA[Adds a false positive information to <i>this</i> retouched Bloom filter.
- <p>
- <b>Invariant</b>: if the false positive is <code>null</code>, nothing happens.
- @param key The false positive key to add.]]>
- </doc>
- </method>
- <method name="addFalsePositive"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="coll" type="java.util.Collection"/>
- <doc>
- <![CDATA[Adds a collection of false positive information to <i>this</i> retouched Bloom filter.
- @param coll The collection of false positive.]]>
- </doc>
- </method>
- <method name="addFalsePositive"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keys" type="java.util.List"/>
- <doc>
- <![CDATA[Adds a list of false positive information to <i>this</i> retouched Bloom filter.
- @param keys The list of false positive.]]>
- </doc>
- </method>
- <method name="addFalsePositive"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keys" type="org.apache.hadoop.util.bloom.Key[]"/>
- <doc>
- <![CDATA[Adds an array of false positive information to <i>this</i> retouched Bloom filter.
- @param keys The array of false positive.]]>
- </doc>
- </method>
- <method name="selectiveClearing"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="k" type="org.apache.hadoop.util.bloom.Key"/>
- <param name="scheme" type="short"/>
- <doc>
- <![CDATA[Performs the selective clearing for a given key.
- @param k The false positive key to remove from <i>this</i> retouched Bloom filter.
- @param scheme The selective clearing scheme to apply.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implements a <i>retouched Bloom filter</i>, as defined in the CoNEXT 2006 paper.
- <p>
- It allows the removal of selected false positives at the cost of introducing
- random false negatives, and with the benefit of eliminating some random false
- positives at the same time.
-
- <p>
- Originally created by
- <a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
-
- @see Filter The general behavior of a filter
- @see BloomFilter A Bloom filter
- @see RemoveScheme The different selective clearing algorithms
-
- @see <a href="http://www-rp.lip6.fr/site_npa/site_rp/_publications/740-rbf_cameraready.pdf">Retouched Bloom Filters: Allowing Networked Applications to Trade Off Selected False Positives Against False Negatives</a>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.RetouchedBloomFilter -->
- </package>
- <package name="org.apache.hadoop.util.curator">
- </package>
- <package name="org.apache.hadoop.util.hash">
- </package>
- </api>
|
